1.1.2.7 OcaVoltageSensor

Class Hierarchy:

OcaRoot → OcaWorker → OcaSensor → OcaVoltageSensor

class OcaVoltageSensor : OcaSensor

Basic voltage sensor.

Properties:

static const OcaClassID ClassID = "1.1.2.7"

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 4.1.

static const OcaClassVersionNumber ClassVersion = 1

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 4.2.

OcaVoltage Reading

Voltage value (volts).

This property has id 4.1.

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 GetReading(OcaVoltage &Reading, OcaVoltage &minReading, OcaVoltage &maxReading)

Gets the value and limits of the Reading property. The return value indicates whether the data was successfully retrieved.

This method has id 4.1.

Parameters

• OcaVoltage Reading – Output parameter.

• OcaVoltage minReading – Output parameter.

• OcaVoltage maxReading – Output 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()