Index

Class OcaTimeSource

ClassID: 1.2.16

extends OcaAgent

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

Properties

static readonly OcaClassID ClassID = 1.2.16

Level: 1 Index: 1

This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 1

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.

OcaTimeSourceAvailability Availability

Level: 3 Index: 1

Availability of this time source.

OcaTimeProtocol Protocol

Level: 3 Index: 2

Time transport protocol used by this time source

OcaSDPString Parameters

Level: 3 Index: 3

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

OcaTimeReferenceType ReferenceType

Level: 3 Index: 4

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

OcaString ReferenceID

Level: 3 Index: 5

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

OcaTimeSourceSyncStatus SyncStatus

Level: 3 Index: 6

Synchronization status of this time source.

Properties inherited from OcaAgent

OcaString Label

OcaONo Owner

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaTimeSource::GetAvailability ( ) → ( OcaTimeSourceAvailability Availability)

Level: 3 Index: 1

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

OcaTimeSource::GetProtocol ( ) → ( OcaTimeProtocol Protocol)

Level: 3 Index: 2

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

OcaTimeSource::SetProtocol ( OcaTimeProtocol Protocol )

Level: 3 Index: 3

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

OcaTimeSource::GetParameters ( ) → ( OcaSDPString Parameters)

Level: 3 Index: 4

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

OcaTimeSource::SetParameters ( OcaSDPString Parameters )

Level: 3 Index: 5

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.

OcaTimeSource::GetReferenceType ( ) → ( OcaTimeReferenceType ReferenceType)

Level: 3 Index: 6

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

OcaTimeSource::SetReferenceType ( OcaTimeReferenceType ReferenceType )

Level: 3 Index: 7

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

OcaTimeSource::GetReferenceID ( ) → ( OcaString ID)

Level: 3 Index: 8

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

OcaTimeSource::SetReferenceID ( OcaString ID )

Level: 3 Index: 9

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

OcaTimeSource::GetSyncStatus ( ) → ( OcaTimeSourceSyncStatus SyncStatus)

Level: 3 Index: 10

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

OcaTimeSource::Reset ( )

Level: 3 Index: 11

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

Methods inherited from OcaAgent

OcaAgent::GetLabel ( ) → ( OcaString Label)

OcaAgent::SetLabel ( OcaString Label )

OcaAgent::GetOwner ( ) → ( OcaONo owner)

OcaAgent::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )