1.1.2.1.13 OcaBitstringSensor

Class Hierarchy:

OcaRoot → OcaWorker → OcaSensor → OcaBasicSensor → OcaBitstringSensor

class OcaBitstringSensor : OcaBasicSensor

Bit string sensor.

Properties:

static const OcaClassID ClassID = "1.1.2.1.13"

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

static const OcaClassVersionNumber ClassVersion = 2

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

OcaBitstring BitString

The bitstring.

This property has id 5.1.

Properties inherited from OcaSensor:

• OcaSensorReadingState OcaSensor::ReadingState

Properties inherited from OcaWorker:

• OcaBoolean OcaWorker::Enabled

• OcaList<OcaPort> OcaWorker::Ports

• OcaString OcaWorker::Label

• OcaONo OcaWorker::Owner

• OcaTimeInterval OcaWorker::Latency

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetNrBits(OcaUint16 &NrBits)

Gets the number of bits of the bitmask data. Returned status indicates success or failure of the retrieval.

This method has id 5.1.

Parameters

OcaUint16 NrBits – Output parameter.

OcaStatus GetBit(OcaUint16 bitNr, OcaUint8 &bit)

Gets the value of the given bit. Return status indicates success or failure of the retrieval.

This method has id 5.2.

Parameters

• OcaUint16 bitNr – Input parameter.

• OcaUint8 bit – Output parameter.

OcaStatus GetBitString(OcaBitstring &BitString)

Gets the entire bitstring. Return status indicates success or failure of the retrieval.

This method has id 5.3.

Parameters

OcaBitstring BitString – Output parameter.

Methods inherited from OcaSensor:

• OcaSensor::GetReadingState(state)

Methods inherited from OcaWorker:

• OcaWorker::GetEnabled(enabled)

• OcaWorker::SetEnabled(enabled)

• OcaWorker::AddPort(Label, Mode, ID)

• OcaWorker::DeletePort(ID)

• OcaWorker::GetPorts(OcaPorts)

• OcaWorker::GetPortName(PortID, Name)

• OcaWorker::SetPortName(PortID, Name)

• OcaWorker::GetLabel(label)

• OcaWorker::SetLabel(label)

• OcaWorker::GetOwner(owner)

• OcaWorker::GetLatency(latency)

• OcaWorker::SetLatency(latency)

• OcaWorker::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()