1.3.1 OcaDeviceManager

Class Hirarchy:

OcaRootOcaManagerOcaDeviceManager

class OcaDeviceManager : OcaManager

Mandatory manager that contains information relevant to the whole device.

  • Must be instantiated once in every device.

  • Must have object number 1.

Properties:

OcaClassID ClassID

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 3.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 3.2.

OcaModelGUID ModelGUID

Read-only property that identifies the model of the device. Note this property is not equivalent to a MAC address, because (a) MAC addresses identify individual devices, not models, and (b) MAC addresses are Ethernet-specific, but an OCA device need not have an Ethernet port.

This property has id 3.1.

OcaString SerialNumber

Read-only property that identifies the serial number of the CAP device.

This property has id 3.2.

OcaModelDescription ModelDescription

Read-only property that contains text names for this model, its manufacturer, and its version.

This property has id 3.3.

OcaString DeviceName

Name of the device. Should be unique manufacturer-qualified identifier.

This property has id 3.4.

OcaUint16 OcaVersion

Read-only property that indicates the AES70 version number used by the device.

This property has id 3.5.

OcaString DeviceRole

Role of device in application (arbitrary).

This property has id 3.6.

OcaString UserInventoryCode

Code used for equipment tracking.

This property has id 3.7.

OcaBoolean Enabled

Indicates whether the device is enabled (and therefore operational).

This property has id 3.8.

OcaDeviceState State

Read-only property that indicates the current state of the device.

This property has id 3.9.

OcaBoolean Busy

True iff device is working on something and is not available for OCA command activity. Readonly.

This property has id 3.10.

OcaResetCause ResetCause

Read-only attribute that indicates the reset cause of the last reset.

This property has id 3.11.

OcaString Message

Arbitrary text message provided by controller. Display and handling of the text is device-dependent and not defined by OCA.

This property has id 3.12.

OcaList<OcaManagerDescriptor> Managers

List of all manager objects instantiated in this device.

This property has id 3.13.

OcaString DeviceRevisionID

Overall device revision identifier. Format of string is manufacturer-specific. Readonly. May be changed by proprietery functions of firmware upload processes.

This property has id 3.14.

Properties inherited from OcaRoot:

Methods:

OcaStatus GetOcaVersion(OcaUint16 &OcaVersion)

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

This method has id 3.1.

Parameters

OcaUint16 OcaVersion – Output parameter.

OcaStatus GetModelGUID(OcaModelGUID &GUID)

Gets the model GUID. The return value indicates whether the GUID was successfully retrieved.

This method has id 3.2.

Parameters

OcaModelGUID GUID – Output parameter.

OcaStatus GetSerialNumber(OcaString &serialNumber)

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

This method has id 3.3.

Parameters

OcaString serialNumber – Output parameter.

OcaStatus GetDeviceName(OcaString &Name)

Gets the device name. The return value indicates whether the property was successfully retrieved.

This method has id 3.4.

Parameters

OcaString Name – Output parameter.

OcaStatus SetDeviceName(OcaString Name)

Sets the device name. The return value indicates whether the property was successfully set.

This method has id 3.5.

Parameters

OcaString Name – Input parameter.

OcaStatus GetModelDescription(OcaModelDescription &Description)

Gets the model description. The return value indicates whether the description was successfully retrieved.

This method has id 3.6.

Parameters

OcaModelDescription Description – Output parameter.

OcaStatus GetDeviceRole(OcaString &role)

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

This method has id 3.7.

Parameters

OcaString role – Output parameter.

OcaStatus SetDeviceRole(OcaString role)

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

This method has id 3.8.

Parameters

OcaString role – Input parameter.

OcaStatus GetUserInventoryCode(OcaString &Code)

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

This method has id 3.9.

Parameters

OcaString Code – Output parameter.

OcaStatus SetUserInventoryCode(OcaString Code)

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

This method has id 3.10.

Parameters

OcaString Code – Input parameter.

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

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

Parameters

OcaBoolean enabled – Input parameter.

OcaStatus GetState(OcaDeviceState &state)

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

This method has id 3.13.

Parameters

OcaDeviceState state – Output parameter.

OcaStatus SetResetKey(OcaBlobFixedLen<16> Key, OcaNetworkAddress Address)

Sets the value of the reset key of the device. The return value indicates whether the property was successfully set. Note that the device manager must inform the CAP gateway of this key (via the host interface), since the CAP gateway will check for and handle the special reset message.

This method has id 3.14.

Parameters
  • OcaBlobFixedLen<16> Key – Input parameter.

  • OcaNetworkAddress Address – Input parameter.

OcaStatus GetResetCause(OcaResetCause &resetCause)

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

This method has id 3.15.

Parameters

OcaResetCause resetCause – Output parameter.

OcaStatus ClearResetCause()

Clears the ResetCause property, i.e. resets it to the default value ‘PowerOn’. Must be used after the reset cause has been read out to ensure differentation between reconnects due to network loss and reconnects due to external or internal reset. Offered as a separate method (instead of implicitly clearing the cause after it has been read out) to accomodate systems that have multiple controllers. The return value indicates whether the property was successfully retrieved.

This method has id 3.16.

OcaStatus GetMessage(OcaString &Message)

Gets the value of property Message . Return value indicates whether value was successfully retrieved.

This method has id 3.17.

Parameters

OcaString Message – Output parameter.

OcaStatus SetMessage(OcaString Text)

Set arbitrary text message into Message property. The return value indicates whether the value was successfully set.

This method has id 3.18.

Parameters

OcaString Text – Input parameter.

OcaStatus GetManagers(OcaList<OcaManagerDescriptor> &Managers)

Retrive the list of descriptors of managers instantiated in this device. The return value indicates whether the retrieval was successful.

This method has id 3.19.

Parameters

OcaList<OcaManagerDescriptor> Managers – Output parameter.

OcaStatus GetDeviceRevisionID(OcaString &ID)

Gets the value of property DeviceRevisionID . Return value indicates whether value was successfully retrieved.

This method has id 3.20.

Parameters

OcaString ID – Output parameter.

Methods inherited from OcaRoot: