template<class Class>
OcaBlock class
Template parameters | |
---|---|
Class | - Class to wrap. |
Contents
This class template detects the methods and events defined for the class OcaBlock in the AES70 specification and exposes them through AES70. Note that all AES70 methods and event handlers need to be public in order to be detected.
Detects the following symbols with the corresponding detector classes:
GetType : aes70::
device:: Getter Return values:
- Type : OcaUint32
ConstructMemberUsingFactory : aes70::
device:: Method Arguments:
- FactoryONo : OcaUint32
Return values:
- ObjectNumber : OcaUint32
DeleteMember : aes70::
device:: Method Arguments:
- ObjectNumber : OcaUint32
GetMembers : aes70::
device:: Getter Return values:
- Members : OcaList<OcaObjectIdentification>
GetMembersRecursive : aes70::
device:: Method Return values:
- Members : OcaList<OcaBlockMember>
AddSignalPath : aes70::
device:: Method Arguments:
- Path : OcaSignalPath
Return values:
- Index : OcaUint16
DeleteSignalPath : aes70::
device:: Method Arguments:
- Index : OcaUint16
GetSignalPaths : aes70::
device:: Getter Return values:
- Members : OcaMap<OcaUint16, OcaSignalPath>
GetSignalPathsRecursive : aes70::
device:: Method Return values:
- Members : OcaMap<OcaUint16, OcaSignalPath>
GetMostRecentParamSetIdentifier : aes70::
device:: Getter Return values:
- Identifier : OcaLibVolIdentifier
ApplyParamSet : aes70::
device:: Method Return values:
- Identifier : OcaLibVolIdentifier
GetCurrentParamSetData : aes70::
device:: Method Return values:
- Data : OcaLibVolData_
ParamSet
- Data : OcaLibVolData_
StoreCurrentParamSetData : aes70::
device:: Method Arguments:
- LibVolIdentifier : OcaLibVolIdentifier
GetGlobalType : aes70::
device:: Getter Return values:
- GlobalType : OcaGlobalTypeIdentifier
GetONoMap : aes70::
device:: Getter Return values:
- ONoMap : OcaMap<OcaUint32, OcaUint32>
FindObjectsByRole : aes70::
device:: Method Arguments:
- SearchName : OcaString
- NameComparisonType : OcaStringComparisonType
- SearchClassID : OcaClassID
- ResultFlags : OcaObjectSearchResultFlags
Return values:
- Result : OcaList<OcaObjectSearchResult>
FindObjectsByRoleRecursive : aes70::
device:: Method Arguments:
- SearchName : OcaString
- NameComparisonType : OcaStringComparisonType
- SearchClassID : OcaClassID
- ResultFlags : OcaObjectSearchResultFlags
Return values:
- Result : OcaList<OcaObjectSearchResult>
FindObjectsByPath : aes70::
device:: Method Arguments:
- SearchPath : OcaList<OcaString>
- ResultFlags : OcaObjectSearchResultFlags
Return values:
- Result : OcaList<OcaObjectSearchResult>
FindObjectsByLabelRecursive : aes70::
device:: Method Arguments:
- SearchName : OcaString
- NameComparisonType : OcaStringComparisonType
- SearchClassID : OcaClassID
- ResultFlags : OcaObjectSearchResultFlags
Return values:
- Result : OcaList<OcaObjectSearchResult>
Detects the following event handlers for property changes (of type aes70::
- OnMembersChanged with property encoder OCP1::
OcaList<OCP1:: Struct<OCP1:: OcaUint32, OCP1:: Struct<OCP1::OcaList<OCP1::OcaUint16>, OCP1:: OcaUint16>>> - OnSignalPathsChanged with property encoder OCP1::
OcaMap<OCP1:: OcaUint16, OCP1:: Struct<OCP1:: Struct<OCP1:: OcaUint32, OCP1::Struct<OCP1::OcaUint8, OCP1::OcaUint16>, OCP1:: OcaString>, OCP1:: Struct<OCP1:: OcaUint32, OCP1::Struct<OCP1::OcaUint8, OCP1::OcaUint16>, OCP1:: OcaString>>> - OnMostRecentParamSetIdentifierChanged with property encoder OCP1::Struct<OCP1::OcaUint32, OCP1::OcaUint32>
From the AES70 standard:
A block is an object with three aspects: - It can contain other blocks. - It can contain workers. - It can contain agents. - It can contain data networks. - It can contain application networks. - It has a signal flow topology. We refer to an object inside a block as a member of that block. We refer to the block which contains an object as the object's container.1 Normally, a block contains a set of members that together function as a processing unit – for example, a crossover channel or mixer strip.
Base classes
-
template<class Class>class OcaWorker
Derived classes
- class aes70::dynamic_device::block
-
template<class... TN>class aes70::static_device::block
-
template<class... TN>class aes70::static_device::block
Public static variables
- static const OcaClassVersionNumber ClassVersion
-
static const classid_
tpl<3> ClassId - static const size_t count_events
Public static functions
- static auto get_event_index(OcaEventID id, size_t index) -> AES70_ALWAYS_INLINE ptrdiff_t
Constructors, destructors, conversion operators
-
template<typename ... TN>OcaBlock(TN && ... args)
Public functions
- auto get_class_version() const -> uint16_t virtual
- auto get_classid() const -> const classid& virtual
-
void init(aes70::
device:: device* d, uint32_t n) virtual -
auto call(const OcaMethodID id,
const uint8_t* src,
const uint8_t* src_end,
uint8_t parameterCount,
const aes70::
response_generator& response) -> bool virtual - auto get_event_index(const OcaEventID OcaEventID) const -> ptrdiff_t virtual
Function documentation
template<classClass>
static AES70_ALWAYS_INLINE ptrdiff_t aes70:: device:: OcaBlock<Class>:: get_event_index(OcaEventID id,
size_t index)
Internal class for finding the event index of a given EventID. Returns -1 if the given event is not defined.
template<classClass>
template<typename ... TN>
aes70:: device:: OcaBlock<Class>:: OcaBlock(TN && ... args)
Constructor which calls the constructor of Class with args forwarded.
template<classClass>
uint16_t aes70:: device:: OcaBlock<Class>:: get_class_version() const virtual
Returns the AES70 class version of this object.
template<classClass>
const classid& aes70:: device:: OcaBlock<Class>:: get_classid() const virtual
Returns the AES70 class id of this object.
template<classClass>
void aes70:: device:: OcaBlock<Class>:: init(aes70:: device:: device* d,
uint32_t n) virtual
Called when this object is added to a device.
template<classClass>
bool aes70:: device:: OcaBlock<Class>:: call(const OcaMethodID id,
const uint8_t* src,
const uint8_t* src_end,
uint8_t parameterCount,
const aes70:: response_generator& response) virtual
Internal method used to call AES70 methods in this object.
template<classClass>
ptrdiff_t aes70:: device:: OcaBlock<Class>:: get_event_index(const OcaEventID OcaEventID) const virtual
Returns the index of a given event. The idea is that all events defined on a aes70 class can be enumerated. For events which this object does not implement, the value -1 is returned.
Variable documentation
template<classClass>
static const OcaClassVersionNumber aes70:: device:: OcaBlock<Class>:: ClassVersion
The ClassVersion of this class according to the AES70 standard.
template<classClass>
static const classid_ tpl<3> aes70:: device:: OcaBlock<Class>:: ClassId
The ClassID of this class according to the AES70 standard.
template<classClass>
static const size_t aes70:: device:: OcaBlock<Class>:: count_events
Number of events defined in this class. This depends on which events are implemented by Class.