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.
static
readonly
OcaClassID ClassID
= 1.3.10
Level: 1 Index: 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.
Level: 1 Index: 2
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.
Level: 3 Index: 1
The list of ONos of OcaTimeSource objects in this device
OcaONo CurrentDeviceTimeSource
Level: 3 Index: 2
The current time source for this device's device time, or zero if none.
OcaTimePTP
TimeOfDay
The current device time. Defined as a private property so that clock updates don't generate property-change events.
Properties inherited from OcaRoot
OcaDeviceTimeManager::GetDeviceTimeNTP (
)
→ (
OcaTimeNTP
DeviceTime)
Level: 3 Index: 1
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.
OcaDeviceTimeManager::SetDeviceTimeNTP (
OcaTimeNTP
DeviceTime )
Level: 3 Index: 2
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.
OcaDeviceTimeManager::GetTimeSources (
)
→ (
OcaList<OcaONo> TimeSourceONos)
Level: 3 Index: 3
Returns list of object numbers of OcaTimeSource instances in this device. Return value indicates whether list was successfully retrieved.
OcaDeviceTimeManager::GetCurrentDeviceTimeSource (
)
→ (
OcaONo TimeSourceONo)
Level: 3 Index: 4
Retrieves ONo of current time source object, or zero if none. Return value indicates whether value was successfully retrieved.
OcaDeviceTimeManager::SetCurrentDeviceTimeSource (
OcaONo TimeSourceONo )
Level: 3 Index: 5
Sets ONo of current time source object, or zero if none. Return value indicates whether value was successfully retrieved.
OcaDeviceTimeManager::GetDeviceTimePTP (
)
→ (
OcaTimePTP
DeviceTime)
Level: 3 Index: 6
Get current value of device time-of-day clock in PTP format. Return value indicates whether value was successfully retrieved.
OcaDeviceTimeManager::SetDeviceTimePTP (
OcaTimePTP
DeviceTime )
Level: 3 Index: 7
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.