1.1.1.5 OcaGain

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaGain

class OcaGain : OcaActuator

Gain (or attenuation) element.

Properties:

static const OcaClassID ClassID = "1.1.1.5"

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.

OcaDB Gain

Gain in dB.

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 GetGain(OcaDB &Gain, OcaDB &minGain, OcaDB &maxGain)

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

This method has id 4.1.

Parameters

• OcaDB Gain – Output parameter.

• OcaDB minGain – Output parameter.

• OcaDB maxGain – Output parameter.

OcaStatus SetGain(OcaDB Gain)

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

This method has id 4.2.

Parameters

OcaDB Gain – 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()