1.3.10 OcaDeviceTimeManager

Class Hierarchy:

OcaRoot : OcaManager : OcaDeviceTimeManager

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

  • May be instantiated at most once in any device.

  • 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:

static const OcaClassID ClassID = "1.3.10"

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.

OcaONo CurrentDeviceTimeSource

ONo of the OcaTimeSource object that represents current time source for this device’s device time, or zero if none.

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.

Properties inherited from 1.3 OcaManager:

Methods:

OcaStatus GetDeviceTimeNTP(OcaTimeNTP &DeviceTime)

Get current value of device time-of-day clock in NTP format. Deprecated in version 3 of this class.

This method has id 3.1.

OcaStatus SetDeviceTimeNTP(OcaTimeNTP DeviceTime)

Sets device time-of-day clock in NTP format. Not available if a time source is identified in property CurrentDeviceTimeSource. Deprecated in version 3 of this class.

This method has id 3.2.

OcaStatus GetTimeSources(OcaList<OcaONo> &TimeSourceONos)

Gets the list of object numbers of OcaTimeSource instances in this device.

This method has id 3.3.

OcaStatus GetCurrentDeviceTimeSource(OcaONo &TimeSourceONo)

Retrieves ONo of current time source object, or zero if none.

This method has id 3.4.

OcaStatus SetCurrentDeviceTimeSource(OcaONo TimeSourceONo)

Sets ONo of current time source object, or zero if none.

This method has id 3.5.

OcaStatus GetDeviceTime(OcaTime &DeviceTime)

Get current value of device time-of-day clock.

This method has id 3.6.

OcaStatus SetDeviceTime(OcaTime DeviceTime)

Sets device time-of-day clock Not available if a time source is identified in property CurrentDeviceTimeSource.

This method has id 3.7.

Methods inherited from 1.3 OcaManager: