1.1.2.6 OcaIdentificationSensor

Class Hierarchy:

OcaRoot : OcaWorker : OcaSensor : OcaIdentificationSensor

class OcaIdentificationSensor : OcaSensor

Sensor for device identification mechanism. This sensor shall detect the actuation of some kind of control – a pushbutton, for instance – that the user depresses to signal a device identification event to the controller.

Properties:

static const OcaClassID ClassID = "1.1.2.6"

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 1.1.

static const OcaClassVersionNumber ClassVersion = 3

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 1.2.

Properties inherited from 1.1.2 OcaSensor:

• OcaClassID OcaRoot::ClassID

• OcaClassVersionNumber OcaRoot::ClassVersion

• OcaBoolean OcaRoot::Lockable

• OcaLockState OcaRoot::LockState

• OcaONo OcaRoot::ObjectNumber

• OcaString OcaRoot::Role

• OcaClassID OcaWorker::ClassID

• OcaClassVersionNumber OcaWorker::ClassVersion

• OcaBoolean OcaWorker::Enabled

• OcaString OcaWorker::Label

• OcaTimeInterval OcaWorker::Latency

• OcaONo OcaWorker::Owner

• OcaMap<OcaPortID, OcaPortClockMapEntry> OcaWorker::PortClockMap

• OcaList<OcaPort> OcaWorker::Ports

• OcaClassID OcaSensor::ClassID

• OcaClassVersionNumber OcaSensor::ClassVersion

• OcaSensorReadingState OcaSensor::ReadingState

Methods:

Methods inherited from 1.1.2 OcaSensor:

• OcaSensor::GetClassIdentification

• OcaSensor::GetLockable

• OcaSensor::GetLockState

• OcaSensor::GetRole

• OcaSensor::SetLockNoWrite

• OcaSensor::SetLockNoReadWrite

• OcaSensor::Unlock

• OcaSensor::AddPort

• OcaSensor::DeletePort

• OcaSensor::DeletePortClockMapEntry

• OcaSensor::GetEnabled

• OcaSensor::GetLabel

• OcaSensor::GetLatency

• OcaSensor::GetOwner

• OcaSensor::GetPath

• OcaSensor::GetPortClockMap

• OcaSensor::GetPortClockMapEntry

• OcaSensor::GetPortName

• OcaSensor::GetPorts

• OcaSensor::SetEnabled

• OcaSensor::SetLabel

• OcaSensor::SetLatency

• OcaSensor::SetPortClockMap

• OcaSensor::SetPortClockMapEntry

• OcaSensor::SetPortName

• OcaSensor::GetReadingState

Events:

void Identify()

Event that shall be raised whenever the Device identification control is activated. No event data.

This event has id 4.1.