Index

Class OcaBlock

ClassID: 1.1.3

extends OcaWorker

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.

Properties

static readonly OcaClassID ClassID = 1.1.3

Level: 1 Index: 1

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This is a class property instead of an object property. This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 2

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.

readonly OcaONo Type

Level: 3 Index: 1

Readonly block type. For statically-defined blocks, this value is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, this value is the object number of the block's factory. For the root block, the value of this property is 1.

OcaList<OcaObjectIdentification> Members

Level: 3 Index: 2

List of members in the block.

OcaMap<OcaUint16,OcaSignalPath> SignalPaths

Level: 3 Index: 3

List of signal paths in the block.

OcaLibVolIdentifier MostRecentParamSetIdentifier

Level: 3 Index: 4

Library volume identifier of the paramset most recently applied to this block.

readonly OcaGlobalTypeIdentifier GlobalType

Level: 3 Index: 5

Global block type identifier for reusable blocks. Added in version 2 of this class.

readonly OcaMap<OcaProtoONo,OcaONo> ONoMap

Level: 3 Index: 6

For blocks constructed by factories. Map that indicates the actual ONos allocated to the constructing OcaBlockFactory's prototype ONos. Key is prototype ONo, value is actual ONo. Added in version 2 of this class.

Properties inherited from OcaWorker

OcaBoolean Enabled

OcaList<OcaPort> Ports

OcaString Label

OcaONo Owner

OcaTimeInterval Latency

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaBlock::GetType ( ) → ( OcaONo Type)

Level: 3 Index: 1

Gets the block type. For statically-defined blocks, the block type is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, the block type is the object number of the block's factory. For the root block, the value of this property is 1.

OcaBlock::ConstructMember ( OcaClassID ClassID, variant ConstructionParameters ) → ( OcaONo ObjectNumber)

Level: 3 Index: 2

Constructs an object according to the given construction specification and adds it to the block. The return value indicates whether the member was successfully created and added.

OcaBlock::ConstructMemberUsingFactory ( OcaONo FactoryONo ) → ( OcaONo ObjectNumber)

Level: 3 Index: 3

Invokes a factory to construct an instance of the given class, then adds it to the block. The return value indicates whether the member was successfully created and added.

OcaBlock::DeleteMember ( OcaONo ObjectNumber )

Level: 3 Index: 4

Removes a member from the block and destroys the object. . Deletes all signal paths attached to its ports. The return value indicates whether the member was successfully removed and destroyed.

OcaBlock::GetMembers ( ) → ( OcaList<OcaObjectIdentification> Members)

Level: 3 Index: 5

Gets the list of block members. Does not recurse inner blocks. Each inner block is included in the returned list as a single object -- its contents are not enumerated. The return value indicates whether the list was successfully retrieved.

OcaBlock::GetMembersRecursive ( ) → ( OcaList<OcaBlockMember> Members)

Level: 3 Index: 6

Gets the list of block members. Recurses inner blocks. Each inner block is included in the returned list as a single object, amd its contents are enumerated. The return value indicates whether the list was successfully retrieved.

OcaBlock::AddSignalPath ( OcaSignalPath Path ) → ( OcaUint16 Index)

Level: 3 Index: 7

Adds a signal path to the block. The return value indicates whether the signal path was successfully added.

OcaBlock::DeleteSignalPath ( OcaUint16 Index )

Level: 3 Index: 8

Deletes a signal path from the block. The return value indicates whether the signal path was successfully added.

OcaBlock::GetSignalPaths ( ) → ( OcaMap<OcaUint16,OcaSignalPath> Members)

Level: 3 Index: 9

Gets the map of signal paths in the block. Does not recurse inner blocks. The return value indicates whether the list was successfully retrieved.

OcaBlock::GetSignalPathsRecursive ( ) → ( OcaMap<OcaUint16,OcaSignalPath> Members)

Level: 3 Index: 10

Gets the mapof signal paths in the block. Recurses inner blocks. The return value indicates whether the list was successfully retrieved.

OcaBlock::GetMostRecentParamSetIdentifier ( ) → ( OcaLibVolIdentifier Identifier)

Level: 3 Index: 11

Gets the identifier of the paramset most recently applied to this block.

OcaBlock::ApplyParamSet ( ) → ( OcaLibVolIdentifier Identifier)

Level: 3 Index: 12

Applies the referenced paramset to this block, and sets the MostRecentParamSet property. The return value indicates whether the paramset was successfully applied.

OcaBlock::GetCurrentParamSetData ( ) → ( OcaLibVolData_ParamSet Data)

Level: 3 Index: 13

Returns a paramset library volume data block which represents the current state of the block -- i.e. a "snapshot".

OcaBlock::StoreCurrentParamSetData ( OcaLibVolIdentifier LibVolIdentifier )

Level: 3 Index: 14

Stores a paramset library volume data block which represents the current state of the block ("snapshot") in the given library. Replaces the library volume at the specified LibVolIdentifier.

OcaBlock::GetGlobalType ( ) → ( OcaGlobalTypeIdentifier GlobalType)

Level: 3 Index: 15

Gets the global blocktype. The return value indicates whether the type was successfully retrieved. If this block has no global blocktype, the Authority field of the returned GlobalType parameter will be zero. Added in version 2 of this class.

OcaBlock::GetONoMap ( ) → ( OcaMap<OcaProtoONo,OcaONo> ONoMap)

Level: 3 Index: 16

Gets the block's ONo map. The return value indicates whether the map was successfully retrieved. Added in version 2 of this class.

OcaBlock::FindObjectsByRole ( OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaObjectSearchResultFlags ResultFlags ) → ( OcaList<OcaObjectSearchResult> Result)

Level: 3 Index: 17

Returns object identifications of all objects in the block that match the given Role search string and Class ID. Return value indicates whether the method succeeded. Added in version 2 of this class.

OcaBlock::FindObjectsByRoleRecursive ( OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaObjectSearchResultFlags ResultFlags ) → ( OcaList<OcaObjectSearchResult> Result)

Level: 3 Index: 18

Returns block member descriptors of all objects in the block and all contained blocks that match the given Role search string and Class ID. Added in version 2 of this class.

OcaBlock::FindObjectsByPath ( OcaNamePath SearchPath, OcaObjectSearchResultFlags ResultFlags ) → ( OcaList<OcaObjectSearchResult> Result)

Level: 3 Index: 20

Returns object identifications of all objects with the given name path. Added in version 2 of this class.

OcaBlock::FindObjectsByLabelRecursive ( OcaString SearchName, OcaStringComparisonType NameComparisonType, OcaClassID SearchClassID, OcaObjectSearchResultFlags ResultFlags ) → ( OcaList<OcaObjectSearchResult> Result)

Level: 3 Index: 19

Returns block member descriptors of all objects in the block and all contained blocks that match the given Label search string and Class ID. Added in version 2 of this class.

Methods inherited from OcaWorker

OcaWorker::GetEnabled ( ) → ( OcaBoolean enabled)

OcaWorker::SetEnabled ( OcaBoolean enabled )

OcaWorker::AddPort ( OcaString Label, OcaPortMode Mode ) → ( OcaPortID ID)

OcaWorker::DeletePort ( OcaPortID ID )

OcaWorker::GetPorts ( ) → ( OcaList<OcaPort> OcaPorts)

OcaWorker::GetPortName ( OcaPortID PortID ) → ( OcaString Name)

OcaWorker::SetPortName ( OcaPortID PortID, OcaString Name )

OcaWorker::GetLabel ( ) → ( OcaString label)

OcaWorker::SetLabel ( OcaString label )

OcaWorker::GetOwner ( ) → ( OcaONo owner)

OcaWorker::GetLatency ( ) → ( OcaTimeInterval latency)

OcaWorker::SetLatency ( OcaTimeInterval latency )

OcaWorker::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 ( )