1.1.1.1.12 OcaStringActuator

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaBasicActuator → OcaStringActuator

class OcaStringActuator : OcaBasicActuator

String actuator.

Properties:

static const OcaClassID ClassID = "1.1.1.1.12"

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.

OcaString Setting

Value.

This property has id 5.1.

const OcaUint16 MaxLen

Maximum string length that this object can accept.

This property has id 5.2.

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 GetSetting(OcaString &Value)

Gets the value and max length of the Value property. The return value indicates whether the data was successfully retrieved.

This method has id 5.1.

Parameters

OcaString Value – Output parameter.

OcaStatus SetSetting(OcaString Value)

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

This method has id 5.2.

Parameters

OcaString Value – Input parameter.

OcaStatus GetMaxLen(OcaUint16 &Len)

Gets the maximum string length that this object can handle.

This method has id 5.3.

Parameters

OcaUint16 Len – Output 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()