1.1 OcaWorker

Class Hierarchy:

OcaRoot : OcaWorker

class OcaWorker : OcaRoot 

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

Properties:

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

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

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 1.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 signal generator is silent, a disabled equalizer is flat, etc.).

This property has id 2.1.

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.

OcaTimeInterval Latency

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

This property has id 2.5.

const OcaONo Owner

Object number of block that contains this worker. Read-only.

This property has id 2.4.

OcaMap<OcaPortID, OcaPortClockMapEntry> PortClockMap

Optional property. Map that connects OcaMediaClock3 object numbers to input and output OcaPorts and specifies sampling rate converters, if any. OcaPortID = {mode,index}, where mode = Input or Output. Map entries with index=0 are default values, to be used when no entry is found for a given port.

This property has id 2.6.

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.

Properties inherited from 1 OcaRoot:

Methods:

OcaStatus GetEnabled(OcaBoolean &enabled)

Gets the value of the Enabled property.

This method has id 2.1.

enabled: Output parameter.

OcaStatus SetEnabled(OcaBoolean enabled)

Sets the value of the Enabled property.

This method has id 2.2.

enabled: Input parameter.

OcaStatus AddPort(OcaString Name, OcaIODirection Mode, OcaPortID &ID)

Adds an input or output port..

This method has id 2.3.

Name: Input parameter.
Mode: Input parameter.
ID: Output parameter.

OcaStatus DeletePort(OcaPortID ID)

Deletes an input or output port..

This method has id 2.4.

ID: Input parameter.

OcaStatus GetPorts(OcaList<OcaPort> &OcaPorts)

Gets the list of ports owned by the Worker object.

This method has id 2.5.

OcaPorts: Output parameter.

OcaStatus GetPortName(OcaPortID PortID, OcaString &Name)

Gets the name of the designated port.

This method has id 2.6.

PortID: Input parameter.
Name: Output parameter.

OcaStatus SetPortName(OcaPortID ID, OcaString Name)

Sets the name of the designated port.

This method has id 2.7.

ID: Input parameter.
Name: Input parameter.

OcaStatus GetLabel(OcaString &label)

Gets the value of the Label property.

This method has id 2.8.

label: Output parameter.

OcaStatus SetLabel(OcaString label)

Sets the value of the Label property.

This method has id 2.9.

label: Input parameter.

OcaStatus GetOwner(OcaONo &owner)

Gets the value of the Owner property.

This method has id 2.10.

owner: Output parameter.

OcaStatus GetLatency(OcaTimeInterval &latency)

Gets the value of the Latency property.

This method has id 2.11.

latency: Output parameter.

OcaStatus SetLatency(OcaTimeInterval latency)

Sets the value of the Latency property.

This method has id 2.12.

latency: Input parameter.

OcaStatus GetPath(OcaRolePath &RolePath, OcaONoPath &ONoPath)

Returns Role Path and ONo Path from the Root Block to this object. The return value indicates whether the operation succeeded.

This method has id 2.13.

RolePath: Output parameter.
ONoPath: Output parameter.

OcaStatus GetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> &Map)

Gets the value of the PortClockMap property.

This method has id 2.14.

Map: Output parameter.

OcaStatus SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map)

Sets the value of the PortClockMap property.

This method has id 2.15.

Map: Input parameter.

OcaStatus GetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry &Entry)

Gets the value of the PortClockMap entry identified by the given PortID.

This method has id 2.16.

ID: Input parameter.
Entry: Output parameter.

OcaStatus SetPortClockMapEntry(OcaPortID PortID, OcaPortClockMapEntry Entry)

Sets an entry in the PortClockMap property. Adds entry if none already exists for the given port; replaces entry if it does already exist.

This method has id 2.17.

PortID: Input parameter.
Entry: Input parameter.

OcaStatus DeletePortClockMapEntry(OcaPortID ID)

Deletes PortClockMap entry identified by the given ID.

This method has id 2.18.

ID: Input parameter.

Methods inherited from 1 OcaRoot: