1.3.1 OcaDeviceManager

Class Hierarchy:

OcaRoot : OcaManager : OcaDeviceManager

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:

OcaBoolean Busy

True if and only if device is working on something and is not available for OCA command activity. Readonly. Deprecated in v3 of this class.

This property has id 3.10.

static const OcaClassID ClassID = "1.3.1"

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 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 ControlEnabled

Indicates whether the device is enabled, i.e. whether it is responsive to OCA commands. Prior to v3 of this class, property name was Enabled.

This property has id 3.8.

OcaString DeviceName

User-specified name of this device in application context. Device instance name, not product name.

This property has id 3.4.

const OcaString DeviceRevisionID

Overall device revision identifier. Format of string is manufacturer-specific. Readonly. May be changed by proprietery functions of firmware upload processes. Deprecated in v3 of this class, moved into property Product.

This property has id 3.14.

OcaString DeviceRole

Role of device in application (arbitrary). Named Role prior to v3 of this class.

This property has id 3.6.

OcaBoolean LoggingEnabled

Global enable/disable switch for device logging. TRUE = logging enabled, FALSE = logging disabled. See class OcaLog for the rest of the logging mechanism.

This property has id 3.18.

OcaList<OcaManagerDescriptor> Managers

List of all manager objects (including the Device Manager) instantiated in this device.

This property has id 3.13.

const OcaManufacturer Manufacturer

Descriptor of this product’s manufacturer.

This property has id 3.15.

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.

OcaModelDescription ModelDescription

Read-only property that contains text names for this model, its manufacturer, and its version. Deprecated in v3 of this class, moved into property Product.

This property has id 3.3.

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. Deprecated in v3 of this class, moved into property Product .

This property has id 3.1.

OcaONo MostRecentPatchDatasetONo

ONo of OcaDataset containing the most recently applied patch. Zero if no patch has been applied since last device reset.

This property has id 3.19.

const OcaUint16 OcaVersion

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

This property has id 3.5.

OcaDeviceOperationalState OperationalState

Operational state of device.

This property has id 3.17.

const OcaProduct Product

Descriptor of this product.

This property has id 3.16.

const OcaResetCause ResetCause

Read-only property that indicates the cause of the last Device reset.

This property has id 3.11.

const OcaString SerialNumber

Read-only property that identifies the serial number of the Device.

This property has id 3.2.

OcaDeviceState State

Read-only property that indicates the current state of the device. Deprecated in v3 of this class, replaced by .OperationalState .

This property has id 3.9.

OcaString UserInventoryCode

Code used for equipment tracking.

This property has id 3.7.

Properties inherited from 1.3 OcaManager:

Methods:

OcaStatus GetOcaVersion(OcaUint16 &OcaVersion)

Gets the value of the OcaVersion property.

This method has id 3.1.

OcaStatus GetModelGUID(OcaModelGUID &GUID)

Gets the model GUID. Deprecated in v3 of this class, replaced by GetProduct() .

This method has id 3.2.

  • GUID: Output parameter.

OcaStatus GetSerialNumber(OcaString &serialNumber)

Gets the value of the SerialNumber property.

This method has id 3.3.

OcaStatus GetDeviceName(OcaString &Name)

Gets the device name.

This method has id 3.4.

  • Name: Output parameter.

OcaStatus SetDeviceName(OcaString Name)

Sets the device name.

This method has id 3.5.

  • Name: Input parameter.

OcaStatus GetModelDescription(OcaModelDescription &Description)

Gets the model description. Deprecated in v3 of this class, replaced by** GetProduct()** .

This method has id 3.6.

OcaStatus GetDeviceRole(OcaString &role)

Gets the value of the DeviceRole property.

This method has id 3.7.

  • role: Output parameter.

OcaStatus SetDeviceRole(OcaString role)

Sets the value of the DeviceRole property.

This method has id 3.8.

  • role: Input parameter.

OcaStatus GetUserInventoryCode(OcaString &Code)

Gets the value of the UserInventoryCode property.

This method has id 3.9.

  • Code: Output parameter.

OcaStatus SetUserInventoryCode(OcaString Code)

Sets the value of the UserInventoryCode property.

This method has id 3.10.

  • Code: Input parameter.

OcaStatus GetEnabled(OcaBoolean &enabled)

Gets the value of the Enabled property. Deprecated in v3 of this class.

This method has id 3.11.

OcaStatus SetEnabled(OcaBoolean enabled)

Sets the value of the Enabled property. Deprecated in v3 of this class.

This method has id 3.12.

OcaStatus GetState(OcaDeviceState &state)

Gets the value of the State property. Deprecated in v3 of this class, replaced by .GetOperationalState() .

This method has id 3.13.

  • state: Output parameter.

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

Sets the value of the reset key and the required source address for the reset command. If given address is null, all source addresses will be accepted.

This method has id 3.14.

OcaStatus GetResetCause(OcaResetCause &resetCause)

Gets the value of the ResetCause property.

This method has id 3.15.

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 differentiation 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 accommodate systems that have multiple controllers.

This method has id 3.16.

OcaStatus GetMessage(OcaString &Message)

Gets the value of property Message.

This method has id 3.17.

OcaStatus SetMessage(OcaString Text)

Set arbitrary text message into Message property.

This method has id 3.18.

  • Text: Input parameter.

OcaStatus GetManagers(OcaList<OcaManagerDescriptor> &Managers)

Retrive the list of descriptors of managers instantiated in this device.

This method has id 3.19.

OcaStatus GetDeviceRevisionID(OcaString &ID)

Gets the value of deprecated property DeviceRevisionID. Deprecated in v3 of this class, replaced by .GetProduct() .

This method has id 3.20.

  • ID: Output parameter.

OcaStatus GetManufacturer(OcaManufacturer &Manufacturer)

Gets the device’s manufacturer descriptor.

This method has id 3.21.

OcaStatus GetProduct(OcaProduct &Product)

Gets the device’s product descriptor.

This method has id 3.22.

OcaStatus GetOperationalState(OcaDeviceOperationalState &State)

Gets the device’s operational state.

This method has id 3.23.

  • State: Output parameter.

OcaStatus GetLoggingEnabled(OcaBoolean &Enabled)

Gets the value of property LoggingEnabled.

This method has id 3.24.

OcaStatus SetLoggingEnabled(OcaBoolean Enabled)

Sets the value of property LoggingEnabled.

This method has id 3.25.

OcaStatus GetMostRecentPatchDatasetONo(OcaONo &ONo)

Gets the value of property MostRecentPatchDatasetONo.

This method has id 3.26.

  • ONo: Output parameter.

OcaStatus ApplyPatch(OcaONo ONo)

Applies the patch in the OcaDataset identified by the given ONo, and sets the value of property MostRecentPatchDatasetONo.

This method has id 3.27.

  • ONo: Input parameter.

Methods inherited from 1.3 OcaManager: