Index

Class OcaBitstringSensor

ClassID: 1.1.2.1.13

extends OcaBasicSensor

Bit string sensor.

Properties

static readonly OcaClassID ClassID = 1.1.2.1.13

Level: 1 Index: 1

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.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 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.

OcaBitstring BitString

Level: 5 Index: 1

The bitstring.

Properties inherited from OcaSensor

static OcaSensorReadingState ReadingState

Properties inherited from OcaWorker

OcaBoolean Enabled

OcaList<OcaPort> Ports

OcaString Label

OcaONo Owner

OcaTimeInterval Latency

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaBitstringSensor::GetNrBits ( ) → ( OcaUint16 NrBits)

Level: 5 Index: 1

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

OcaBitstringSensor::GetBit ( OcaUint16 bitNr ) → ( OcaUint8 bit)

Level: 5 Index: 2

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

OcaBitstringSensor::GetBitString ( ) → ( OcaBitstring BitString)

Level: 5 Index: 3

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

Methods inherited from OcaSensor

OcaSensor::GetReadingState ( ) → ( OcaSensorReadingState state)

Methods inherited from OcaWorker

OcaWorker::GetEnabled ( ) → ( OcaBoolean enabled)

OcaWorker::SetEnabled ( OcaBoolean enabled )

OcaWorker::AddPort ( OcaString Label, OcaPortMode Mode ) → ( OcaPortID ID)

OcaWorker::DeletePort ( OcaPortID ID )

OcaWorker::GetPorts ( ) → ( OcaList<OcaPort> OcaPorts)

OcaWorker::GetPortName ( OcaPortID PortID ) → ( OcaString Name)

OcaWorker::SetPortName ( OcaPortID PortID, OcaString Name )

OcaWorker::GetLabel ( ) → ( OcaString label)

OcaWorker::SetLabel ( OcaString label )

OcaWorker::GetOwner ( ) → ( OcaONo owner)

OcaWorker::GetLatency ( ) → ( OcaTimeInterval latency)

OcaWorker::SetLatency ( OcaTimeInterval latency )

OcaWorker::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )