1.1.1.15 OcaDynamicsDetector

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaDynamicsDetector

class OcaDynamicsDetector : OcaActuator

Dynamics element : side-chain detector.

Properties:

OcaTimeInterval AttackTime

Detector attack time in seconds.

This property has id 4.2.

static const OcaClassID ClassID = "1.1.1.15"

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.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

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.

This property has id 1.2.

OcaTimeInterval HoldTime

Detector hold time in seconds.

This property has id 4.4.

OcaLevelDetectionLaw Law

Level detection law: RMS, Peak, possibly others

This property has id 4.1.

OcaTimeInterval ReleaseTime

Detector release time in seconds.

This property has id 4.3.

Properties inherited from 1.1.1 OcaActuator:

Methods:

OcaStatus GetLaw(OcaLevelDetectionLaw &Law)

Gets the value of the Law property.

This method has id 4.1.

  • Law: Output parameter.

OcaStatus SetLaw(OcaLevelDetectionLaw Law)

Sets the value of the Law property.

This method has id 4.2.

  • Law: Input parameter.

OcaStatus GetAttackTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the AttackTime property.

This method has id 4.3.

OcaStatus SetAttackTime(OcaTimeInterval Time)

Sets the value of the AttackTime property.

This method has id 4.4.

  • Time: Input parameter.

OcaStatus GetReleaseTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the ReleaseTime property.

This method has id 4.5.

OcaStatus SetReleaseTime(OcaTimeInterval Time)

Sets the value of the ReleaseTime property.

This method has id 4.6.

  • Time: Input parameter.

OcaStatus GetHoldTime(OcaTimeInterval &Time, OcaTimeInterval &minTime, OcaTimeInterval &maxTime)

Gets the value and limits of the HoldTime property.

This method has id 4.7.

OcaStatus SetHoldTime(OcaTimeInterval Time)

Sets the value of the HoldTime property.

This method has id 4.8.

  • Time: Input parameter.

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

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.

This method has id 4.9.

Methods inherited from 1.1.1 OcaActuator: