1.1.1.13 OcaFilterArbitraryCurve

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaFilterArbitraryCurve

class OcaFilterArbitraryCurve : OcaActuator

Arbitrary-curve filter, with transfer function specified as amplitude and phase versus frequency.

Properties:

static const OcaClassID ClassID = "1.1.1.13"

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.

OcaFrequency SampleRate

Sampling rate inside the filter. Note: This rate is not necessarily the same as the Device input or output sampling rate.

This property has id 4.2.

OcaUint16 TFMaxLength

Maximum number of points that the transfer function may specify

This property has id 4.4.

OcaUint16 TFMinLength

Minimum number of points that the transfer function must specify

This property has id 4.3.

OcaTransferFunction TransferFunction

Transfer function of the filter.

This property has id 4.1.

Properties inherited from 1.1.1 OcaActuator:

Methods:

OcaStatus GetTransferFunction(OcaTransferFunction &TransferFunction)

Gets the complex transfer function.

This method has id 4.1.

OcaStatus SetTransferFunction(OcaTransferFunction TransferFunction)

Sets the complex transfer function.

This method has id 4.2.

OcaStatus GetSampleRate(OcaFrequency &Rate, OcaFrequency &minRate, OcaFrequency &maxRate)

Gets the value and limits of the filter sampling rate.

This method has id 4.3.

OcaStatus SetSampleRate(OcaFrequency Rate)

Sets the filter sampling rate.

This method has id 4.4.

  • Rate: Input parameter.

OcaStatus GetTFMinLength(OcaUint16 &Min)

Gets the value and limits of the TFMinLength property.

This method has id 4.5.

  • Min: Output parameter.

OcaStatus GetTFMaxLength(OcaUint16 &Max)

Gets the value and limits of the TFMaxLength property.

This method has id 4.6.

  • Max: Output parameter.

Methods inherited from 1.1.1 OcaActuator: