1.1.2.1.12 OcaStringSensor

Class Hierarchy:

OcaRoot → OcaWorker → OcaSensor → OcaBasicSensor → OcaStringSensor

class OcaStringSensor : OcaBasicSensor

Text string sensor.

Properties:

static const OcaClassID ClassID = "1.1.2.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 String

The string.

This property has id 5.1.

OcaUint16 MaxLen

Maximum length of the returned string. May be readonly in some implementations.

This property has id 5.2.

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 GetString(OcaString &String)

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

This method has id 5.1.

Parameters

OcaString String – Output parameter.

OcaStatus GetMaxLen(OcaUint16 &maxLen)

Gets the maximum number of bytes that may be returned. Returned status indicates success or failure of the retrieval.

This method has id 5.2.

Parameters

OcaUint16 maxLen – Output parameter.

OcaStatus SetMaxLen(OcaUint16 maxLen)

Sets the maximum number of bytes that the object may return. Returned status indicates success or failure of the set.

This method has id 5.3.

Parameters

OcaUint16 maxLen – Input 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()