1.1.1.21 OcaIdentificationActuator

Class Hirarchy:

OcaRootOcaWorkerOcaActuatorOcaIdentificationActuator

class OcaIdentificationActuator : OcaActuator

Represents a function that turns on some kind of human-detectable indicator for purposes of device identification during network setup. Physical form of indicator is not defined by OCA, so it could be anything, e.g.

  • LED

  • Foghorn

  • Smoke emitter

  • Little waving robot hand wearing white glove

  • Jack-in-the-box popout

  • et cetera

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.

OcaBoolean Active

True iff indicator is active.

This property has id 4.1.

Properties inherited from OcaWorker:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetActive(OcaBoolean &active)

Gets the current identification indicator activity state. The return value indicates whether the state was successfully retrieved.

This method has id 4.1.

Parameters

OcaBoolean active – Output parameter.

OcaStatus SetActive(OcaBoolean active)

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

This method has id 4.2.

Parameters

OcaBoolean active – Input parameter.

Methods inherited from OcaWorker:

Methods inherited from OcaRoot: