Skip to content

OcaTimeSource#

This document describes the controller implementation of OcaTimeSource. This class is documented in the AES70 standard as:

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

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaTimeSource : public OcaAgent
  {
  public:
    OcaTimeSource(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaTimeSource(const OcaTimeSource &o);

    // Control Methods
    // Calls GetAvailability and calls on_result or on_failure
    void GetAvailability(auto on_result, failure_callback on_failure);
    // Calls GetTimeDeliveryMechanism and calls on_result or on_failure
    void GetTimeDeliveryMechanism(auto on_result, failure_callback on_failure);
    // Calls SetTimeDeliveryMechanism and calls on_result or on_failure
    void SetTimeDeliveryMechanism(OcaTimeDeliveryMechanism Mechanism, auto on_result, failure_callback on_failure);
    // Calls SetTimeDeliveryMechanism and does not wait for the response
    void SetTimeDeliveryMechanism(OcaTimeDeliveryMechanism Mechanism);
    // Calls GetReferenceSDPDescription and calls on_result or on_failure
    void GetReferenceSDPDescription(auto on_result, failure_callback on_failure);
    // Calls SetReferenceSDPDescription and calls on_result or on_failure
    void SetReferenceSDPDescription(OcaSDPString Parameters, auto on_result, failure_callback on_failure);
    // Calls SetReferenceSDPDescription and does not wait for the response
    void SetReferenceSDPDescription(OcaSDPString Parameters);
    // Calls GetReferenceType and calls on_result or on_failure
    void GetReferenceType(auto on_result, failure_callback on_failure);
    // Calls SetReferenceType and calls on_result or on_failure
    void SetReferenceType(OcaTimeReferenceType ReferenceType, auto on_result, failure_callback on_failure);
    // Calls SetReferenceType and does not wait for the response
    void SetReferenceType(OcaTimeReferenceType ReferenceType);
    // Calls GetReferenceID and calls on_result or on_failure
    void GetReferenceID(auto on_result, failure_callback on_failure);
    // Calls SetReferenceID and calls on_result or on_failure
    void SetReferenceID(OcaString ID, auto on_result, failure_callback on_failure);
    // Calls SetReferenceID and does not wait for the response
    void SetReferenceID(OcaString ID);
    // Calls GetSyncStatus and calls on_result or on_failure
    void GetSyncStatus(auto on_result, failure_callback on_failure);
    // Calls Reset and calls on_result or on_failure
    void Reset(auto on_result, failure_callback on_failure);
    // Calls GetTimeDeliveryParameters and calls on_result or on_failure
    void GetTimeDeliveryParameters(auto on_result, failure_callback on_failure);
    // Calls SetTimeDeliveryParameters and calls on_result or on_failure
    void SetTimeDeliveryParameters(OcaParameterRecord Record, auto on_result, failure_callback on_failure);
    // Calls SetTimeDeliveryParameters and does not wait for the response
    void SetTimeDeliveryParameters(OcaParameterRecord Record);

    // Observing Properties
    subscription observeAvailability(auto callback, failure_callback on_failure);
    subscription observeTimeDeliveryMechanism(auto callback, failure_callback on_failure);
    subscription observeReferenceSDPDescription(auto callback, failure_callback on_failure);
    subscription observeReferenceType(auto callback, failure_callback on_failure);
    subscription observeReferenceID(auto callback, failure_callback on_failure);
    subscription observeSyncStatus(auto callback, failure_callback on_failure);
    subscription observeTimeDeliveryParameters(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnAvailabilityChanged(auto callback, failure_callback on_failure);
    subscription OnTimeDeliveryMechanismChanged(auto callback, failure_callback on_failure);
    subscription OnReferenceSDPDescriptionChanged(auto callback, failure_callback on_failure);
    subscription OnReferenceTypeChanged(auto callback, failure_callback on_failure);
    subscription OnReferenceIDChanged(auto callback, failure_callback on_failure);
    subscription OnSyncStatusChanged(auto callback, failure_callback on_failure);
    subscription OnTimeDeliveryParametersChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetAvailability#

void GetAvailability(auto on_result, failure_callback on_failure)

Calls the method GetAvailability in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaTimeSourceAvailability Availability
  • failure_callback on_failure: A callback which is called on error.

GetTimeDeliveryMechanism#

void GetTimeDeliveryMechanism(auto on_result, failure_callback on_failure)

Calls the method GetTimeDeliveryMechanism in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaTimeDeliveryMechanism Mechanism
  • failure_callback on_failure: A callback which is called on error.

SetTimeDeliveryMechanism#

void SetTimeDeliveryMechanism(OcaTimeDeliveryMechanism Mechanism, auto on_result, failure_callback on_failure)

Calls the method SetTimeDeliveryMechanism in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaTimeDeliveryMechanism Mechanism
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetReferenceSDPDescription#

void GetReferenceSDPDescription(auto on_result, failure_callback on_failure)

Calls the method GetReferenceSDPDescription in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaSDPString Parameters
  • failure_callback on_failure: A callback which is called on error.

SetReferenceSDPDescription#

void SetReferenceSDPDescription(OcaSDPString Parameters, auto on_result, failure_callback on_failure)

Calls the method SetReferenceSDPDescription in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaSDPString Parameters
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetReferenceType#

void GetReferenceType(auto on_result, failure_callback on_failure)

Calls the method GetReferenceType in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaTimeReferenceType ReferenceType
  • failure_callback on_failure: A callback which is called on error.

SetReferenceType#

void SetReferenceType(OcaTimeReferenceType ReferenceType, auto on_result, failure_callback on_failure)

Calls the method SetReferenceType in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaTimeReferenceType ReferenceType
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetReferenceID#

void GetReferenceID(auto on_result, failure_callback on_failure)

Calls the method GetReferenceID in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaString ID
  • failure_callback on_failure: A callback which is called on error.

SetReferenceID#

void SetReferenceID(OcaString ID, auto on_result, failure_callback on_failure)

Calls the method SetReferenceID in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaString ID
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetSyncStatus#

void GetSyncStatus(auto on_result, failure_callback on_failure)

Calls the method GetSyncStatus in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaTimeSourceSyncStatus SyncStatus
  • failure_callback on_failure: A callback which is called on error.

Reset#

void Reset(auto on_result, failure_callback on_failure)

Calls the method Reset in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetTimeDeliveryParameters#

void GetTimeDeliveryParameters(auto on_result, failure_callback on_failure)

Calls the method GetTimeDeliveryParameters in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaParameterRecord Record
  • failure_callback on_failure: A callback which is called on error.

SetTimeDeliveryParameters#

void SetTimeDeliveryParameters(OcaParameterRecord Record, auto on_result, failure_callback on_failure)

Calls the method SetTimeDeliveryParameters in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaParameterRecord Record
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

observeAvailability#

subscription observeAvailability(auto callback, failure_callback on_failure)

Fetches the remote property Availability and subscribes for modifications. The callback is called with the initial values of Availability and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeSourceAvailability Availability
  • failure_callback on_failure: A callback which is called on error.

observeTimeDeliveryMechanism#

subscription observeTimeDeliveryMechanism(auto callback, failure_callback on_failure)

Fetches the remote property TimeDeliveryMechanism and subscribes for modifications. The callback is called with the initial values of TimeDeliveryMechanism and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeDeliveryMechanism TimeDeliveryMechanism
  • failure_callback on_failure: A callback which is called on error.

observeReferenceSDPDescription#

subscription observeReferenceSDPDescription(auto callback, failure_callback on_failure)

Fetches the remote property ReferenceSDPDescription and subscribes for modifications. The callback is called with the initial values of ReferenceSDPDescription and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaSDPString ReferenceSDPDescription
  • failure_callback on_failure: A callback which is called on error.

observeReferenceType#

subscription observeReferenceType(auto callback, failure_callback on_failure)

Fetches the remote property ReferenceType and subscribes for modifications. The callback is called with the initial values of ReferenceType and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeReferenceType ReferenceType
  • failure_callback on_failure: A callback which is called on error.

observeReferenceID#

subscription observeReferenceID(auto callback, failure_callback on_failure)

Fetches the remote property ReferenceID and subscribes for modifications. The callback is called with the initial values of ReferenceID and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaString ReferenceID
  • failure_callback on_failure: A callback which is called on error.

observeSyncStatus#

subscription observeSyncStatus(auto callback, failure_callback on_failure)

Fetches the remote property SyncStatus and subscribes for modifications. The callback is called with the initial values of SyncStatus and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeSourceSyncStatus SyncStatus
  • failure_callback on_failure: A callback which is called on error.

observeTimeDeliveryParameters#

subscription observeTimeDeliveryParameters(auto callback, failure_callback on_failure)

Fetches the remote property TimeDeliveryParameters and subscribes for modifications. The callback is called with the initial values of TimeDeliveryParameters and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaParameterRecord TimeDeliveryParameters
  • failure_callback on_failure: A callback which is called on error.

OnAvailabilityChanged#

subscription OnAvailabilityChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeSourceAvailability Availability
  • failure_callback on_failure: A callback which is called on error.

OnTimeDeliveryMechanismChanged#

subscription OnTimeDeliveryMechanismChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeDeliveryMechanism TimeDeliveryMechanism
  • failure_callback on_failure: A callback which is called on error.

OnReferenceSDPDescriptionChanged#

subscription OnReferenceSDPDescriptionChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaSDPString ReferenceSDPDescription
  • failure_callback on_failure: A callback which is called on error.

OnReferenceTypeChanged#

subscription OnReferenceTypeChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeReferenceType ReferenceType
  • failure_callback on_failure: A callback which is called on error.

OnReferenceIDChanged#

subscription OnReferenceIDChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaString ReferenceID
  • failure_callback on_failure: A callback which is called on error.

OnSyncStatusChanged#

subscription OnSyncStatusChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaTimeSourceSyncStatus SyncStatus
  • failure_callback on_failure: A callback which is called on error.

OnTimeDeliveryParametersChanged#

subscription OnTimeDeliveryParametersChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaParameterRecord TimeDeliveryParameters
  • failure_callback on_failure: A callback which is called on error.