1.1.1.15 OcaDynamicsDetector

Class Hirarchy:

OcaRootOcaWorkerOcaActuatorOcaDynamicsDetector

class OcaDynamicsDetector : OcaActuator

Dynamics element : side-chain detector.

Properties:

OcaClassID ClassID

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 4.1.

OcaClassVersionNumber ClassVersion

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 4.2.

OcaLevelDetectionLaw Law

Level detection law: RMS, Peak, possibly others

This property has id 4.1.

OcaTimeInterval AttackTime

Detector attack time in seconds.

This property has id 4.2.

OcaTimeInterval ReleaseTime

Detector release time in seconds.

This property has id 4.3.

OcaTimeInterval HoldTime

Detector hold time in seconds.

This property has id 4.4.

Properties inherited from OcaWorker:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetLaw(OcaLevelDetectionLaw &Law)

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

This method has id 4.1.

Parameters

OcaLevelDetectionLaw Law – Output parameter.

OcaStatus SetLaw(OcaLevelDetectionLaw Law)

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

This method has id 4.2.

Parameters

OcaLevelDetectionLaw Law – Input parameter.

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

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

This method has id 4.3.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetAttackTime(OcaTimeInterval Time)

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

This method has id 4.4.

Parameters

OcaTimeInterval Time – Input parameter.

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

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

This method has id 4.5.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetReleaseTime(OcaTimeInterval Time)

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

This method has id 4.6.

Parameters

OcaTimeInterval Time – Input parameter.

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

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

This method has id 4.7.

Parameters
  • OcaTimeInterval Time – Output parameter.

  • OcaTimeInterval minTime – Output parameter.

  • OcaTimeInterval maxTime – Output parameter.

OcaStatus SetHoldTime(OcaTimeInterval Time)

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

This method has id 4.8.

Parameters

OcaTimeInterval 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.

Parameters
  • OcaParameterMask Mask – Input parameter.

  • OcaLevelDetectionLaw Law – Input parameter.

  • OcaTimeInterval AttackTime – Input parameter.

  • OcaTimeInterval ReleaseTime – Input parameter.

  • OcaTimeInterval HoldTime – Input parameter.

Methods inherited from OcaWorker:

Methods inherited from OcaRoot: