Index

Class OcaStringSensor

ClassID: 1.1.2.1.12

extends OcaBasicSensor

Text string sensor.

Properties

static readonly OcaClassID ClassID = 1.1.2.1.12

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.

OcaString String

Level: 5 Index: 1

The string.

OcaUint16 MaxLen

Level: 5 Index: 2

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

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

OcaStringSensor::GetString ( ) → ( OcaString String)

Level: 5 Index: 1

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

OcaStringSensor::GetMaxLen ( ) → ( OcaUint16 maxLen)

Level: 5 Index: 2

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

OcaStringSensor::SetMaxLen ( OcaUint16 maxLen )

Level: 5 Index: 3

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

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