1.1 OcaWorker

Class Hirarchy:

OcaRootOcaWorker

class OcaWorker : OcaRoot

Abstract base class for classes that represent the device’s application and support functions.

Properties:

OcaClassID ClassID

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.

This property has id 2.1.

OcaClassVersionNumber ClassVersion

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

OcaBoolean Enabled

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

This property has id 2.1.

OcaList<OcaPort> Ports

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

This property has id 2.2.

OcaString Label

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.

This property has id 2.3.

OcaONo Owner

Object number of block that contains this worker.

This property has id 2.4.

OcaTimeInterval Latency

Processing latency of this object. Optional. Readonly or readwrite, depending on implementation.

This property has id 2.5.

Properties inherited from OcaRoot:

Methods:

OcaStatus GetEnabled(OcaBoolean &enabled)

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

This method has id 2.1.

Parameters

OcaBoolean enabled – Output parameter.

OcaStatus SetEnabled(OcaBoolean enabled)

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

This method has id 2.2.

Parameters

OcaBoolean enabled – Input parameter.

OcaStatus AddPort(OcaString Label, OcaPortMode Mode, OcaPortID &ID)

Adds an input or output port.. The return value indicates whether the port was successfully added.

This method has id 2.3.

Parameters
  • OcaString Label – Input parameter.

  • OcaPortMode Mode – Input parameter.

  • OcaPortID ID – Output parameter.

OcaStatus DeletePort(OcaPortID ID)

Deletes an input or output port.. The return value indicates whether the port was successfully deleted.

This method has id 2.4.

Parameters

OcaPortID ID – Input parameter.

OcaStatus GetPorts(OcaList<OcaPort> &OcaPorts)

Gets the list of ports owned by the Worker object. The return value indicates whether the list was successfully retrieved.

This method has id 2.5.

Parameters

OcaList<OcaPort> OcaPorts – Output parameter.

OcaStatus GetPortName(OcaPortID PortID, OcaString &Name)

Gets the name of the designated port. The return value indicates whether the name was successfully retrieved.

This method has id 2.6.

Parameters
  • OcaPortID PortID – Input parameter.

  • OcaString Name – Output parameter.

OcaStatus SetPortName(OcaPortID PortID, OcaString Name)

Sets the name of the designated port. The return value indicates whether the name was successfully set.

This method has id 2.7.

Parameters
  • OcaPortID PortID – Input parameter.

  • OcaString Name – Input parameter.

OcaStatus GetLabel(OcaString &label)

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

This method has id 2.8.

Parameters

OcaString label – Output parameter.

OcaStatus SetLabel(OcaString label)

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

This method has id 2.9.

Parameters

OcaString label – Input parameter.

OcaStatus GetOwner(OcaONo &owner)

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

This method has id 2.10.

Parameters

OcaONo owner – Output parameter.

OcaStatus GetLatency(OcaTimeInterval &latency)

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

This method has id 2.11.

Parameters

OcaTimeInterval latency – Output parameter.

OcaStatus SetLatency(OcaTimeInterval latency)

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

This method has id 2.12.

Parameters

OcaTimeInterval latency – Input parameter.

OcaStatus GetPath(OcaNamePath &NamePath, OcaONoPath &ONoPath)

Returns path from the given object down to root. The return value indicates whether the operation succeeded. Added in version 2.

This method has id 2.13.

Parameters
  • OcaNamePath NamePath – Output parameter.

  • OcaONoPath ONoPath – Output parameter.

Methods inherited from OcaRoot: