1.3.10 OcaDeviceTimeManager

Class Hirarchy:

OcaRootOcaManagerOcaDeviceTimeManager

class OcaDeviceTimeManager : OcaManager

Manager that allows controlling and monitoring a device’s time-of-day clock, and that collects the device’s time source objects.

  • Must be instantiated once in every device that has more than one

time source object. In this context, a “time source object” is an instance of OcaTimeSource or a subclass of it.

  • If instantiated, object number must be 10.

Note: The clock value is accessible via Get and Set methods, but has not been defined as a public property because its value is volatile and should not cause property-change events. The current value of the OcaTimeSource object designated by the CurrentDeviceTimeSource property of this Manager is known as the Device Time . The property TimeSources was added in version 2 of this class.

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.

OcaList<OcaONo> TimeSources

The list of ONos of OcaTimeSource objects in this device

This property has id 3.1.

OcaONo CurrentDeviceTimeSource

The current time source for this device’s device time, or zero if none.

This property has id 3.2.

OcaTimePTP DeviceTimePTP

The current device time. Defined as a private property so that clock updates don’t generate property-change events.

This property has id 3.0.

Properties inherited from OcaRoot:

Methods:

OcaStatus GetDeviceTimeNTP(OcaTimeNTP &DeviceTime)

Get current value of device time-of-day clock in NTP format. Return value indicates whether value was successfully retrieved. This method is _optional_ and _deprecated_ .

This method has id 3.1.

Parameters

OcaTimeNTP DeviceTime – Output parameter.

OcaStatus SetDeviceTimeNTP(OcaTimeNTP DeviceTime)

Sets device time-of-day clock in NTP format. Return value indicates whether value was successfully set. Not available if a time source is identified in property CurrentDeviceTimeSource. This method is _optional_ and _deprecated_ .

This method has id 3.2.

Parameters

OcaTimeNTP DeviceTime – Input parameter.

OcaStatus GetTimeSources(OcaList<OcaONo> &TimeSourceONos)

Returns list of object numbers of OcaTimeSource instances in this device. Return value indicates whether list was successfully retrieved.

This method has id 3.3.

Parameters

OcaList<OcaONo> TimeSourceONos – Output parameter.

OcaStatus GetCurrentDeviceTimeSource(OcaONo &TimeSourceONo)

Retrieves ONo of current time source object, or zero if none. Return value indicates whether value was successfully retrieved.

This method has id 3.4.

Parameters

OcaONo TimeSourceONo – Output parameter.

OcaStatus SetCurrentDeviceTimeSource(OcaONo TimeSourceONo)

Sets ONo of current time source object, or zero if none. Return value indicates whether value was successfully retrieved.

This method has id 3.5.

Parameters

OcaONo TimeSourceONo – Input parameter.

OcaStatus GetDeviceTimePTP(OcaTimePTP &DeviceTime)

Get current value of device time-of-day clock in PTP format. Return value indicates whether value was successfully retrieved.

This method has id 3.6.

Parameters

OcaTimePTP DeviceTime – Output parameter.

OcaStatus SetDeviceTimePTP(OcaTimePTP DeviceTime)

Sets device time-of-day clock in PTP format. Return value indicates whether value was successfully set. Not available if a time source is identified in property CurrentDeviceTimeSource.

This method has id 3.7.

Parameters

OcaTimePTP DeviceTime – Input parameter.

Methods inherited from OcaRoot: