Skip to content

OcaBlock#

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

Collection object for hierarchical structuring of Control Object populations.

The term Block means an instance of OcaBlock. A Block may contain Action Objects and/or Dataset Objects, where:

An Action Object is defined as one of: Worker object;, Agent object;, Network Interface object;, Network Application object.

A Dataset Object is defined an instance of OcaDataset or of a subclass of OcaDataset.

The term Block Member (or just Member in context) means an object contained in a Block - either an Action Object or a Dataset Object. The Block that contains an object is termed the object's Owner.

A Block may define a Signal Flow that represents internal signal flows among its Members.

Typically, a Block contains a set of Members that together function as a processing unit -- for example, a crossover channel or mixer strip.

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetType and calls on_result or on_failure
    void GetType(auto on_result, failure_callback on_failure);
    // Calls ConstructActionObject and calls on_result or on_failure
    void ConstructActionObject(OcaClassID ClassID, OcaList<OcaConstructionParameter> ConstructionParameters, auto on_result, failure_callback on_failure);
    // Calls ConstructActionObject and does not wait for the response
    void ConstructActionObject(OcaClassID ClassID, OcaList<OcaConstructionParameter> ConstructionParameters);
    // Calls ConstructBlockUsingFactory and calls on_result or on_failure
    void ConstructBlockUsingFactory(OcaONo FactoryONo, auto on_result, failure_callback on_failure);
    // Calls ConstructBlockUsingFactory and does not wait for the response
    void ConstructBlockUsingFactory(OcaONo FactoryONo);
    // Calls DeleteMember and calls on_result or on_failure
    void DeleteMember(OcaONo ObjectNumber, auto on_result, failure_callback on_failure);
    // Calls DeleteMember and does not wait for the response
    void DeleteMember(OcaONo ObjectNumber);
    // Calls GetActionObjects and calls on_result or on_failure
    void GetActionObjects(auto on_result, failure_callback on_failure);
    // Calls GetActionObjectsRecursive and calls on_result or on_failure
    void GetActionObjectsRecursive(auto on_result, failure_callback on_failure);
    // Calls AddSignalPath and calls on_result or on_failure
    void AddSignalPath(OcaSignalPath Path, auto on_result, failure_callback on_failure);
    // Calls AddSignalPath and does not wait for the response
    void AddSignalPath(OcaSignalPath Path);
    // Calls DeleteSignalPath and calls on_result or on_failure
    void DeleteSignalPath(OcaID16 Index, auto on_result, failure_callback on_failure);
    // Calls DeleteSignalPath and does not wait for the response
    void DeleteSignalPath(OcaID16 Index);
    // Calls GetSignalPaths and calls on_result or on_failure
    void GetSignalPaths(auto on_result, failure_callback on_failure);
    // Calls GetSignalPathsRecursive and calls on_result or on_failure
    void GetSignalPathsRecursive(auto on_result, failure_callback on_failure);
    // Calls GetMostRecentParamSetIdentifier and calls on_result or on_failure
    void GetMostRecentParamSetIdentifier(auto on_result, failure_callback on_failure);
    // Calls ApplyParamSet and calls on_result or on_failure
    void ApplyParamSet(auto on_result, failure_callback on_failure);
    // Calls GetCurrentParamSetData and calls on_result or on_failure
    void GetCurrentParamSetData(auto on_result, failure_callback on_failure);
    // Calls StoreCurrentParamSetData and calls on_result or on_failure
    void StoreCurrentParamSetData(OcaLibVolIdentifier Identifier, auto on_result, failure_callback on_failure);
    // Calls StoreCurrentParamSetData and does not wait for the response
    void StoreCurrentParamSetData(OcaLibVolIdentifier Identifier);
    // Calls GetGlobalType and calls on_result or on_failure
    void GetGlobalType(auto on_result, failure_callback on_failure);
    // Calls GetONoMap and calls on_result or on_failure
    void GetONoMap(auto on_result, failure_callback on_failure);
    // Calls FindActionObjectsByRole and calls on_result or on_failure
    void FindActionObjectsByRole(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure);
    // Calls FindActionObjectsByRole and does not wait for the response
    void FindActionObjectsByRole(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags);
    // Calls FindActionObjectsByRoleRecursive and calls on_result or on_failure
    void FindActionObjectsByRoleRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure);
    // Calls FindActionObjectsByRoleRecursive and does not wait for the response
    void FindActionObjectsByRoleRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags);
    // Calls FindActionObjectsByLabelRecursive and calls on_result or on_failure
    void FindActionObjectsByLabelRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure);
    // Calls FindActionObjectsByLabelRecursive and does not wait for the response
    void FindActionObjectsByLabelRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags);
    // Calls FindActionObjectsByRolePath and calls on_result or on_failure
    void FindActionObjectsByRolePath(OcaRolePath SearchPath, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure);
    // Calls FindActionObjectsByRolePath and does not wait for the response
    void FindActionObjectsByRolePath(OcaRolePath SearchPath, OcaActionObjectSearchResultFlags ResultFlags);
    // Calls GetConfigurability and calls on_result or on_failure
    void GetConfigurability(auto on_result, failure_callback on_failure);
    // Calls GetMostRecentParamDatasetONo and calls on_result or on_failure
    void GetMostRecentParamDatasetONo(auto on_result, failure_callback on_failure);
    // Calls ApplyParamDataset and calls on_result or on_failure
    void ApplyParamDataset(OcaONo ONo, auto on_result, failure_callback on_failure);
    // Calls ApplyParamDataset and does not wait for the response
    void ApplyParamDataset(OcaONo ONo);
    // Calls StoreCurrentParameterData and calls on_result or on_failure
    void StoreCurrentParameterData(OcaONo ONo, auto on_result, failure_callback on_failure);
    // Calls StoreCurrentParameterData and does not wait for the response
    void StoreCurrentParameterData(OcaONo ONo);
    // Calls FetchCurrentParameterData and calls on_result or on_failure
    void FetchCurrentParameterData(auto on_result, failure_callback on_failure);
    // Calls ApplyParameterData and calls on_result or on_failure
    void ApplyParameterData(auto on_result, failure_callback on_failure);
    // Calls ConstructDataset and calls on_result or on_failure
    void ConstructDataset(OcaClassID ClassID, OcaString Name, OcaMimeType Type, OcaUint64 MaxSize, OcaLongBlob InitialContents, auto on_result, failure_callback on_failure);
    // Calls ConstructDataset and does not wait for the response
    void ConstructDataset(OcaClassID ClassID, OcaString Name, OcaMimeType Type, OcaUint64 MaxSize, OcaLongBlob InitialContents);
    // Calls DuplicateDataset and calls on_result or on_failure
    void DuplicateDataset(OcaONo OldONo, OcaONo TargetBlockONo, OcaString NewName, OcaUint64 NewMaxSize, auto on_result, failure_callback on_failure);
    // Calls DuplicateDataset and does not wait for the response
    void DuplicateDataset(OcaONo OldONo, OcaONo TargetBlockONo, OcaString NewName, OcaUint64 NewMaxSize);
    // Calls GetDatasetObjects and calls on_result or on_failure
    void GetDatasetObjects(auto on_result, failure_callback on_failure);
    // Calls GetDatasetObjectsRecursive and calls on_result or on_failure
    void GetDatasetObjectsRecursive(auto on_result, failure_callback on_failure);
    // Calls FindDatasets and calls on_result or on_failure
    void FindDatasets(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType, auto on_result, failure_callback on_failure);
    // Calls FindDatasets and does not wait for the response
    void FindDatasets(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType);
    // Calls FindDatasetsRecursive and calls on_result or on_failure
    void FindDatasetsRecursive(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType, auto on_result, failure_callback on_failure);
    // Calls FindDatasetsRecursive and does not wait for the response
    void FindDatasetsRecursive(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType);
    // Calls GetBlockFactoryONo and calls on_result or on_failure
    void GetBlockFactoryONo(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeActionObjects(auto callback, failure_callback on_failure);
    subscription observeSignalPaths(auto callback, failure_callback on_failure);
    subscription observeMostRecentParamSetIdentifier(auto callback, failure_callback on_failure);
    subscription observeDatasetObjects(auto callback, failure_callback on_failure);
    subscription observeMostRecentParamDatasetONo(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnActionObjectsChanged(auto callback, failure_callback on_failure);
    subscription OnSignalPathsChanged(auto callback, failure_callback on_failure);
    subscription OnMostRecentParamSetIdentifierChanged(auto callback, failure_callback on_failure);
    subscription OnDatasetObjectsChanged(auto callback, failure_callback on_failure);
    subscription OnMostRecentParamDatasetONoChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetType#

void GetType(auto on_result, failure_callback on_failure)

Calls the method GetType in the remote device.

Parameters:#

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

ConstructActionObject#

void ConstructActionObject(OcaClassID ClassID, OcaList<OcaConstructionParameter> ConstructionParameters, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaClassID ClassID
  • OcaList<OcaConstructionParameter> ConstructionParameters
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaONo ObjectNumber
  • failure_callback on_failure: A callback which is called on error.

ConstructBlockUsingFactory#

void ConstructBlockUsingFactory(OcaONo FactoryONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DeleteMember#

void DeleteMember(OcaONo ObjectNumber, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetActionObjects#

void GetActionObjects(auto on_result, failure_callback on_failure)

Calls the method GetActionObjects in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaObjectIdentification> Objects
  • failure_callback on_failure: A callback which is called on error.

GetActionObjectsRecursive#

void GetActionObjectsRecursive(auto on_result, failure_callback on_failure)

Calls the method GetActionObjectsRecursive in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaBlockMember> Objects
  • failure_callback on_failure: A callback which is called on error.

AddSignalPath#

void AddSignalPath(OcaSignalPath Path, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DeleteSignalPath#

void DeleteSignalPath(OcaID16 Index, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetSignalPaths#

void GetSignalPaths(auto on_result, failure_callback on_failure)

Calls the method GetSignalPaths in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaMap<OcaID16, OcaSignalPath> Members
  • failure_callback on_failure: A callback which is called on error.

GetSignalPathsRecursive#

void GetSignalPathsRecursive(auto on_result, failure_callback on_failure)

Calls the method GetSignalPathsRecursive in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaMap<OcaID16, OcaSignalPath> SignalPaths
  • failure_callback on_failure: A callback which is called on error.

GetMostRecentParamSetIdentifier#

void GetMostRecentParamSetIdentifier(auto on_result, failure_callback on_failure)

Calls the method GetMostRecentParamSetIdentifier in the remote device.

Parameters:#

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

ApplyParamSet#

void ApplyParamSet(auto on_result, failure_callback on_failure)

Calls the method ApplyParamSet in the remote device.

Parameters:#

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

GetCurrentParamSetData#

void GetCurrentParamSetData(auto on_result, failure_callback on_failure)

Calls the method GetCurrentParamSetData in the remote device.

Parameters:#

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

StoreCurrentParamSetData#

void StoreCurrentParamSetData(OcaLibVolIdentifier Identifier, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetGlobalType#

void GetGlobalType(auto on_result, failure_callback on_failure)

Calls the method GetGlobalType in the remote device.

Parameters:#

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

GetONoMap#

void GetONoMap(auto on_result, failure_callback on_failure)

Calls the method GetONoMap in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaMap<OcaProtoONo, OcaONo> ONoMap
  • failure_callback on_failure: A callback which is called on error.

FindActionObjectsByRole#

void FindActionObjectsByRole(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString SearchName
  • OcaStringComparisonType NameComparisonType
  • OcaClassID SearchClassID
  • OcaActionObjectSearchResultFlags ResultFlags
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaActionObjectSearchResult> Result
  • failure_callback on_failure: A callback which is called on error.

FindActionObjectsByRoleRecursive#

void FindActionObjectsByRoleRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString SearchName
  • OcaStringComparisonType NameComparisonType
  • OcaClassID SearchClassID
  • OcaActionObjectSearchResultFlags ResultFlags
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaActionObjectSearchResult> Result
  • failure_callback on_failure: A callback which is called on error.

FindActionObjectsByLabelRecursive#

void FindActionObjectsByLabelRecursive(OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString SearchName
  • OcaStringComparisonType NameComparisonType
  • OcaClassID SearchClassID
  • OcaActionObjectSearchResultFlags ResultFlags
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaActionObjectSearchResult> Result
  • failure_callback on_failure: A callback which is called on error.

FindActionObjectsByRolePath#

void FindActionObjectsByRolePath(OcaRolePath SearchPath, OcaActionObjectSearchResultFlags ResultFlags, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaRolePath SearchPath
  • OcaActionObjectSearchResultFlags ResultFlags
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaActionObjectSearchResult> Result
  • failure_callback on_failure: A callback which is called on error.

GetConfigurability#

void GetConfigurability(auto on_result, failure_callback on_failure)

Calls the method GetConfigurability in the remote device.

Parameters:#

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

GetMostRecentParamDatasetONo#

void GetMostRecentParamDatasetONo(auto on_result, failure_callback on_failure)

Calls the method GetMostRecentParamDatasetONo in the remote device.

Parameters:#

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

ApplyParamDataset#

void ApplyParamDataset(OcaONo ONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

StoreCurrentParameterData#

void StoreCurrentParameterData(OcaONo ONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

FetchCurrentParameterData#

void FetchCurrentParameterData(auto on_result, failure_callback on_failure)

Calls the method FetchCurrentParameterData in the remote device.

Parameters:#

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

ApplyParameterData#

void ApplyParameterData(auto on_result, failure_callback on_failure)

Calls the method ApplyParameterData in the remote device.

Parameters:#

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

ConstructDataset#

void ConstructDataset(OcaClassID ClassID, OcaString Name, OcaMimeType Type, OcaUint64 MaxSize, OcaLongBlob InitialContents, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaClassID ClassID
  • OcaString Name
  • OcaMimeType Type
  • OcaUint64 MaxSize
  • OcaLongBlob InitialContents
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaONo ObjectNumber
  • failure_callback on_failure: A callback which is called on error.

DuplicateDataset#

void DuplicateDataset(OcaONo OldONo, OcaONo TargetBlockONo, OcaString NewName, OcaUint64 NewMaxSize, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaONo OldONo
  • OcaONo TargetBlockONo
  • OcaString NewName
  • OcaUint64 NewMaxSize
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaONo NewONo
  • failure_callback on_failure: A callback which is called on error.

GetDatasetObjects#

void GetDatasetObjects(auto on_result, failure_callback on_failure)

Calls the method GetDatasetObjects in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaObjectIdentification> Objects
  • failure_callback on_failure: A callback which is called on error.

GetDatasetObjectsRecursive#

void GetDatasetObjectsRecursive(auto on_result, failure_callback on_failure)

Calls the method GetDatasetObjectsRecursive in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaBlockMember> Objects
  • failure_callback on_failure: A callback which is called on error.

FindDatasets#

void FindDatasets(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString Name
  • OcaStringComparisonType NameComparisonType
  • OcaMimeType Type
  • OcaStringComparisonType TypeComparisonType
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaDatasetSearchResult> Datasets
  • failure_callback on_failure: A callback which is called on error.

FindDatasetsRecursive#

void FindDatasetsRecursive(OcaString Name, OcaStringComparisonType NameComparisonType, OcaMimeType Type, OcaStringComparisonType TypeComparisonType, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaString Name
  • OcaStringComparisonType NameComparisonType
  • OcaMimeType Type
  • OcaStringComparisonType TypeComparisonType
  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaDatasetSearchResult> Datasets
  • failure_callback on_failure: A callback which is called on error.

GetBlockFactoryONo#

void GetBlockFactoryONo(auto on_result, failure_callback on_failure)

Calls the method GetBlockFactoryONo in the remote device.

Parameters:#

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

observeActionObjects#

subscription observeActionObjects(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaObjectIdentification> ActionObjects
  • failure_callback on_failure: A callback which is called on error.

observeSignalPaths#

subscription observeSignalPaths(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaMap<OcaID16, OcaSignalPath> SignalPaths
  • failure_callback on_failure: A callback which is called on error.

observeMostRecentParamSetIdentifier#

subscription observeMostRecentParamSetIdentifier(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeDatasetObjects#

subscription observeDatasetObjects(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaObjectIdentification> DatasetObjects
  • failure_callback on_failure: A callback which is called on error.

observeMostRecentParamDatasetONo#

subscription observeMostRecentParamDatasetONo(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnActionObjectsChanged#

subscription OnActionObjectsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaObjectIdentification> ActionObjects
  • failure_callback on_failure: A callback which is called on error.

OnSignalPathsChanged#

subscription OnSignalPathsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaMap<OcaID16, OcaSignalPath> SignalPaths
  • failure_callback on_failure: A callback which is called on error.

OnMostRecentParamSetIdentifierChanged#

subscription OnMostRecentParamSetIdentifierChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnDatasetObjectsChanged#

subscription OnDatasetObjectsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaObjectIdentification> DatasetObjects
  • failure_callback on_failure: A callback which is called on error.

OnMostRecentParamDatasetONoChanged#

subscription OnMostRecentParamDatasetONoChanged(auto callback, failure_callback on_failure)

Parameters#

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