Index

Class OcaDynamicsDetector

ClassID: 1.1.1.15

extends OcaActuator

Dynamics element : side-chain detector.

Properties

static readonly OcaClassID ClassID = 1.1.1.15

Level: 1 Index: 1

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. 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.

OcaLevelDetectionLaw Law

Level: 4 Index: 1

Level detection law: RMS, Peak, possibly others

OcaTimeInterval AttackTime

Level: 4 Index: 2

Detector attack time in seconds.

OcaTimeInterval ReleaseTime

Level: 4 Index: 3

Detector release time in seconds.

OcaTimeInterval HoldTime

Level: 4 Index: 4

Detector hold time in seconds.

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

OcaDynamicsDetector::GetLaw ( ) → ( OcaLevelDetectionLaw Law)

Level: 4 Index: 1

Gets the value of the Law property. Return status indicates whether the value was successfully retrieved.

OcaDynamicsDetector::SetLaw ( OcaLevelDetectionLaw Law )

Level: 4 Index: 2

Sets the value of the Law property. Return status indicates whether the value was successfully set.

OcaDynamicsDetector::GetAttackTime ( ) → ( OcaTimeInterval Time, OcaTimeInterval minTime, OcaTimeInterval maxTime)

Level: 4 Index: 3

Gets the value of the AttackTime property. The return value indicates if the value was successfully retrieved.

OcaDynamicsDetector::SetAttackTime ( OcaTimeInterval Time )

Level: 4 Index: 4

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

OcaDynamicsDetector::GetReleaseTime ( ) → ( OcaTimeInterval Time, OcaTimeInterval minTime, OcaTimeInterval maxTime)

Level: 4 Index: 5

Gets the value of the ReleaseTime property. The return value indicates if the value was successfully retrieved.

OcaDynamicsDetector::SetReleaseTime ( OcaTimeInterval Time )

Level: 4 Index: 6

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

OcaDynamicsDetector::GetHoldTime ( ) → ( OcaTimeInterval Time, OcaTimeInterval minTime, OcaTimeInterval maxTime)

Level: 4 Index: 7

Gets the value of the HoldTime property. The return value indicates if the value was successfully retrieved.

OcaDynamicsDetector::SetHoldTime ( OcaTimeInterval Time )

Level: 4 Index: 8

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

OcaDynamicsDetector::SetMultiple ( OcaParameterMask Mask, OcaLevelDetectionLaw Law, OcaTimeInterval AttackTime, OcaTimeInterval ReleaseTime, OcaTimeInterval HoldTime )

Level: 4 Index: 9

Sets some or all detector parameters. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.

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