Index

Class OcaBitstringActuator

ClassID: 1.1.1.1.13

extends OcaBasicActuator

Bitstring actuator. Maximum bitstring length is 65,536 bits.

Properties

static readonly OcaClassID ClassID = 1.1.1.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 data.

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

OcaBitstringActuator::GetNrBits ( ) → ( OcaUint16 nrBits)

Level: 5 Index: 1

Gets the number of bits in the string. The return value indicates whether the property was successfully gathered.

OcaBitstringActuator::GetBit ( OcaUint16 bitNr ) → ( OcaBoolean Value)

Level: 5 Index: 2

Gets the bit value of the given bit. The return value indicates whether the property was successfully gathered.

OcaBitstringActuator::SetBit ( OcaUint16 bitNr, OcaBoolean Value )

Level: 5 Index: 3

Sets the bit value of the given bit. The return value indicates whether the property was successfully set.

OcaBitstringActuator::GetBitstring ( ) → ( OcaBitstring BitString)

Level: 5 Index: 4

Gets the entire bitstring.The return value indicates whether the property was successfully gathered.

OcaBitstringActuator::SetBitstring ( OcaBitstring BitString )

Level: 5 Index: 5

Sets the entire bitstring. The return value indicates whether the property was successfully set.

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 ( )