Abstract base class for classes that represent the device's application and support functions.
static
readonly
OcaClassID ClassID
= 1.1
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.
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.
Level: 2 Index: 1
Read/write property that indicates whether the worker object is enabled in the device. If an object is disabled it cannot be used by the application. Note that the behavior of a disabled object depends on the object itself (e.g. a disabled chime generator is silent, a disabled equalizer is flat, etc.).
Level: 2 Index: 2
The list of (input and output) OCA ports the worker object has. Note that a worker object can have no ports (in which case the list is empty).
Level: 2 Index: 3
Specific label of the worker. Can be used to provide human readable information about the worker. The label can be get and set over the network.
Level: 2 Index: 4
Object number of block that contains this worker.
OcaTimeInterval
Latency
Level: 2 Index: 5
Processing latency of this object. Optional. Readonly or readwrite, depending on implementation.
Properties inherited from OcaRoot
OcaWorker::GetEnabled (
)
→ (
OcaBoolean enabled)
Level: 2 Index: 1
Gets the value of the Enabled property. The return value indicates whether the property was successfully retrieved.
OcaWorker::SetEnabled (
OcaBoolean enabled )
Level: 2 Index: 2
Sets the value of the Enabled property. The return value indicates whether the property was successfully set.
Level: 2 Index: 3
Adds an input or output port.. The return value indicates whether the port was successfully added.
OcaWorker::DeletePort (
OcaPortID ID )
Level: 2 Index: 4
Deletes an input or output port.. The return value indicates whether the port was successfully deleted.
OcaWorker::GetPorts (
)
→ (
OcaList<OcaPort> OcaPorts)
Level: 2 Index: 5
Gets the list of ports owned by the Worker object. The return value indicates whether the list was successfully retrieved.
OcaWorker::GetPortName (
OcaPortID PortID )
→ (
OcaString Name)
Level: 2 Index: 6
Gets the name of the designated port. The return value indicates whether the name was successfully retrieved.
OcaWorker::SetPortName (
OcaPortID PortID, OcaString Name )
Level: 2 Index: 7
Sets the name of the designated port. The return value indicates whether the name was successfully set.
OcaWorker::GetLabel (
)
→ (
OcaString label)
Level: 2 Index: 8
Gets the value of the Label property. The return value indicates whether the property was successfully retrieved.
OcaWorker::SetLabel (
OcaString label )
Level: 2 Index: 9
Sets the value of the Label property. The return value indicates whether the property was successfully set.
OcaWorker::GetOwner (
)
→ (
OcaONo owner)
Level: 2 Index: 10
Gets the value of the Owner property. The return value indicates whether the property was successfully retrieved.
OcaWorker::GetLatency (
)
→ (
OcaTimeInterval
latency)
Level: 2 Index: 11
Gets the value of the Latency property. The return value indicates whether the property was successfully retrieved.
OcaWorker::SetLatency (
OcaTimeInterval
latency )
Level: 2 Index: 12
Sets the value of the Latency property. The return value indicates whether the property was successfully set.
OcaWorker::GetPath (
)
→ (
OcaNamePath NamePath, OcaONoPath ONoPath)
Level: 2 Index: 13
Returns path from the given object down to root. The return value indicates whether the operation succeeded. Added in version 2.