1.2.16 OcaTimeSource

Class Hierarchy:

OcaRoot → OcaAgent → OcaTimeSource

class OcaTimeSource : OcaAgent

A time source, internal or external. See RFC 7273 for a detailed discussion of time sources.

Properties:

static const OcaClassID ClassID = "1.2.16"

This property is an override of the OcaRoot property.

This property has id 3.1.

static const OcaClassVersionNumber ClassVersion = 1

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.

OcaTimeSourceAvailability Availability

Availability of this time source.

This property has id 3.1.

OcaTimeProtocol Protocol

Time transport protocol used by this time source

This property has id 3.2.

OcaSDPString Parameters

Parameters (identifiers, modifiers, etc.) for this time source . Content is an SDP timestamp reference specification as defined in RFC7273, section 4.8.

This property has id 3.3.

OcaTimeReferenceType ReferenceType

Type of time reference to which this time source is synced, if any.

This property has id 3.4.

OcaString ReferenceID

Identifier of reference to which this time source is synced, if any. Not needed for all reference types.

This property has id 3.5.

OcaTimeSourceSyncStatus SyncStatus

Synchronization status of this time source.

This property has id 3.6.

Properties inherited from OcaAgent:

• OcaString OcaAgent::Label

• OcaONo OcaAgent::Owner

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetAvailability(OcaTimeSourceAvailability &Availability)

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

This method has id 3.1.

Parameters

OcaTimeSourceAvailability Availability – Output parameter.

OcaStatus GetProtocol(OcaTimeProtocol &Protocol)

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

This method has id 3.2.

Parameters

OcaTimeProtocol Protocol – Output parameter.

OcaStatus SetProtocol(OcaTimeProtocol Protocol)

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

This method has id 3.3.

Parameters

OcaTimeProtocol Protocol – Input parameter.

OcaStatus GetParameters(OcaSDPString &Parameters)

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

This method has id 3.4.

Parameters

OcaSDPString Parameters – Output parameter.

OcaStatus SetParameters(OcaSDPString Parameters)

Sets the value of the Parameters property. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

This method has id 3.5.

Parameters

OcaSDPString Parameters – Input parameter.

OcaStatus GetReferenceType(OcaTimeReferenceType &ReferenceType)

Gets the time reference type. The return value indicates whether the value was successfully retrieved.

This method has id 3.6.

Parameters

OcaTimeReferenceType ReferenceType – Output parameter.

OcaStatus SetReferenceType(OcaTimeReferenceType ReferenceType)

Sets the time reference type. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

This method has id 3.7.

Parameters

OcaTimeReferenceType ReferenceType – Input parameter.

OcaStatus GetReferenceID(OcaString &ID)

Gets the timing source ID. The return value indicates whether the value was successfully retrieved. Optional method, not required for all time reference types.

This method has id 3.8.

Parameters

OcaString ID – Output parameter.

OcaStatus SetReferenceID(OcaString ID)

Sets the time reference ID. The return value indicates whether the ID was successfully set. Optional method, not required for all time reference types.

This method has id 3.9.

Parameters

OcaString ID – Input parameter.

OcaStatus GetSyncStatus(OcaTimeSourceSyncStatus &SyncStatus)

Gets the synchronization status of this time source. The return value indicates whether the value was successfully retrieved.

This method has id 3.10.

Parameters

OcaTimeSourceSyncStatus SyncStatus – Output parameter.

OcaStatus Reset()

Resets this time source. Initiates a new synchronization sequence. The return value indicates whether the reset was successful.

This method has id 3.11.

Methods inherited from OcaAgent:

• OcaAgent::GetLabel(Label)

• OcaAgent::SetLabel(Label)

• OcaAgent::GetOwner(owner)

• OcaAgent::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()