Index

Class OcaSensor

ClassID: 1.1.2

extends OcaWorker

Abstract base class for all sensor classes.

Properties

static readonly OcaClassID ClassID = 1.1.2

Level: 1 Index: 1

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This is a class property instead of an object property. 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.

static OcaSensorReadingState ReadingState

Level: 3 Index: 1

Enum that describes whether current reading value is valid and if not, why not. Readonly.

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

OcaSensor::GetReadingState ( ) → ( OcaSensorReadingState state)

Level: 3 Index: 1

Gets the current reading state of the sensor. The return value indicates whether the state was successfully retrived.

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