1.1.1.1.13 OcaBitstringActuator

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaBasicActuator → OcaBitstringActuator

class OcaBitstringActuator : OcaBasicActuator

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

Properties:

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

This property has id 5.1.

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 in the string. The return value indicates whether the property was successfully gathered.

This method has id 5.1.

Parameters

OcaUint16 nrBits – Output parameter.

OcaStatus GetBit(OcaUint16 bitNr, OcaBoolean &Value)

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

This method has id 5.2.

Parameters

• OcaUint16 bitNr – Input parameter.

• OcaBoolean Value – Output parameter.

OcaStatus SetBit(OcaUint16 bitNr, OcaBoolean Value)

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

This method has id 5.3.

Parameters

• OcaUint16 bitNr – Input parameter.

• OcaBoolean Value – Input parameter.

OcaStatus GetBitstring(OcaBitstring &BitString)

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

This method has id 5.4.

Parameters

OcaBitstring BitString – Output parameter.

OcaStatus SetBitstring(OcaBitstring BitString)

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

This method has id 5.5.

Parameters

OcaBitstring BitString – Input parameter.

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