1.2.16 OcaTimeSource

Class Hierarchy:

OcaRoot : OcaAgent : OcaTimeSource

class OcaTimeSource : OcaAgent

A time source, internal or external, and the delivery method by which time values reach this device.

Properties:

OcaTimeSourceAvailability Availability

Availability of this time source.

This property has id 3.1.

static const OcaClassID ClassID = "1.2.16"

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.

OcaSDPString ReferenceSDPDescription

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

This property has id 3.3.

OcaTimeDeliveryMechanism TimeDeliveryMechanism

Time delivery mechanism used by this time source. Named Protocol prior to v3 of this class.

This property has id 3.2.

OcaString ReferenceID

Identifier of reference to which this time source is synchronized, if any. Not needed for all time reference types. This property is deprecated.

This property has id 3.5.

OcaTimeReferenceType ReferenceType

Type of time reference to which this time source is synchronized, if any. This property is deprecated.

This property has id 3.4.

OcaTimeSourceSyncStatus SyncStatus

Synchronization status of this time source.

This property has id 3.6.

OcaParameterRecord TimeDeliveryParameters

External parameter record for time delivery parameters. If TimeDeliveryMechanism**=**StreamEndpoint, then the schema of this parameter record shall be defined by the datatype OcaTimeDeliveryParameters_StreamEndpoint. Otherwise, the schema shall depend on the time delivery method chosen, and is out of scope of AES70-2.

This property has id 3.7.

Properties inherited from 1.2 OcaAgent:

Methods:

OcaStatus GetAvailability(OcaTimeSourceAvailability &Availability)

Gets the value of the Availability property.

This method has id 3.1.

OcaStatus GetTimeDeliveryMechanism(OcaTimeDeliveryMechanism &Mechanism)

Gets the value of the TimeDeliveryMechanism property. Prior to v3 of this class, was named GetProtocol.

This method has id 3.2.

OcaStatus SetTimeDeliveryMechanism(OcaTimeDeliveryMechanism Mechanism)

Sets the value of the TimeDeliveryMechanism property. Prior to v3 of this class, was named SetProtocol.

This method has id 3.3.

OcaStatus GetReferenceSDPDescription(OcaSDPString &Parameters)

Gets the value of the ReferenceSDPDescription property.

This method has id 3.4.

OcaStatus SetReferenceSDPDescription(OcaSDPString Parameters)

Sets the value of the ReferenceSDPDescription property. Optional method, may not be supported in all implementations.

This method has id 3.5.

OcaStatus GetReferenceType(OcaTimeReferenceType &ReferenceType)

Gets the time reference type. This method is deprecated.

This method has id 3.6.

OcaStatus SetReferenceType(OcaTimeReferenceType ReferenceType)

Sets the time reference type. Optional method, may not be supported in all implementations. This method is deprecated.

This method has id 3.7.

OcaStatus GetReferenceID(OcaString &ID)

Gets the timing source ID. Optional method, not required for all time reference types.

This method has id 3.8.

  • ID: Output parameter.

OcaStatus SetReferenceID(OcaString ID)

Sets the time reference ID. Optional method, not required for all time reference types.

This method has id 3.9.

  • ID: Input parameter.

OcaStatus GetSyncStatus(OcaTimeSourceSyncStatus &SyncStatus)

Gets the synchronization status of this time source.

This method has id 3.10.

OcaStatus Reset()

Resets this time source. Initiates a new synchronization sequence.

This method has id 3.11.

OcaStatus GetTimeDeliveryParameters(OcaParameterRecord &Record)

Gets the value of the TimeDeliveryParameters property. Optional method.

This method has id 3.12.

OcaStatus SetTimeDeliveryParameters(OcaParameterRecord Record)

Sets the value of the TimeDeliveryParameters property. Optional method.

This method has id 3.13.

Methods inherited from 1.2 OcaAgent: