1.1.1.7.1 OcaDelayExtended

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaDelay → OcaDelayExtended

class OcaDelayExtended : OcaDelay

Signal delay - extended version. Allows setting delay value in various units. Note that the inherited property 04p01 DelayTime is also supported by this class and reflects actual achieved delay in seconds.

Properties:

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

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.

OcaDelayValue DelayValue

Delay value.

This property has id 5.1.

Properties inherited from OcaDelay:

• OcaTimeInterval OcaDelay::DelayTime

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 GetDelayValue(OcaDelayValue &Value, OcaDelayValue &minValue, OcaDelayValue &maxValue)

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

This method has id 5.1.

Parameters

• OcaDelayValue Value – Output parameter.

• OcaDelayValue minValue – Output parameter.

• OcaDelayValue maxValue – Output parameter.

OcaStatus SetDelayValue(OcaDelayValue Value)

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

This method has id 5.2.

Parameters

OcaDelayValue Value – Input parameter.

OcaStatus GetDelayValueConverted(OcaDelayUnit UoM, OcaDelayValue &Value)

Return current delay setting, converted to given units. The return value indicates whether the method has succeeded.

This method has id 5.3.

Parameters

• OcaDelayUnit UoM – Input parameter.

• OcaDelayValue Value – Output parameter.

Methods inherited from OcaDelay:

• OcaDelay::GetDelayTime(Time, minTime, maxTime)

• OcaDelay::SetDelayTime(delayTime)

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