1.1.1.3 OcaPolarity

Class Hirarchy:

OcaRootOcaWorkerOcaActuatorOcaPolarity

class OcaPolarity : OcaActuator

Signal inverter

Properties:

OcaClassID ClassID

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 4.1.

OcaClassVersionNumber ClassVersion

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 4.2.

OcaPolarityState State

Current state of the inverter - {noninverted, inverted].

This property has id 4.1.

Properties inherited from OcaWorker:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetState(OcaPolarityState &state)

Gets the current inverter state. The return value indicates whether the state was successfully retrieved.

This method has id 4.1.

Parameters

OcaPolarityState state – Output parameter.

OcaStatus SetState(OcaPolarityState state)

Sets the inversion state (i.e. value of the State property). The return value indicates whether the state was successfully set.

This method has id 4.2.

Parameters

OcaPolarityState state – Input parameter.

Methods inherited from OcaWorker:

Methods inherited from OcaRoot: