1.1.1.20 OcaTemperatureActuator

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaTemperatureActuator

class OcaTemperatureActuator : OcaActuator

A temperature actuator. Works in Celsius.

Properties:

static const OcaClassID ClassID = "1.1.1.20"

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

OcaTemperature Temperature

The temperature.

This property has id 4.1.

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 GetTemperature(OcaTemperature &temperature, OcaTemperature &minTemperature, OcaTemperature &maxTemperature)

Gets the value of the Temperature property. The return value indicates whether the property was successfully retrieved.

This method has id 4.1.

Parameters

• OcaTemperature temperature – Output parameter.

• OcaTemperature minTemperature – Output parameter.

• OcaTemperature maxTemperature – Output parameter.

OcaStatus SetTemperature(OcaTemperature temperature)

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

This method has id 4.2.

Parameters

OcaTemperature temperature – Input 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()