1.1.1.12 OcaFilterFIR

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaFilterFIR

class OcaFilterFIR : OcaActuator

Finite impulse response (FIR) filter.

Properties:

static const OcaClassID ClassID = "1.1.1.12"

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.

OcaList<OcaFloat32> Coefficients

Array of FIR Coefficients. Number of entries shall be equal to the value of the Order property plus 1.

This property has id 4.2.

OcaUint32 Length

Length of the filter, in samples. Readonly.

This property has id 4.1.

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

Properties inherited from 1.1.1 OcaActuator:

Methods:

OcaStatus GetLength(OcaUint32 &Length, OcaUint32 &minLength, OcaUint32 &maxLength)

Gets the length and length limits of the FIR filter.

This method has id 4.1.

OcaStatus GetCoefficients(OcaList<OcaFloat32> &Coefficients)

Gets the coefficients of the FIR filter.

This method has id 4.2.

OcaStatus SetCoefficients(OcaList<OcaFloat32> Coefficients)

Sets the coefficients of the FIR filter.

This method has id 4.3.

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

Gets the value and limits of the SampleRate property.

This method has id 4.4.

OcaStatus SetSampleRate(OcaFrequency Rate)

Sets the sampling rate of the FIR filter.

This method has id 4.5.

  • Rate: Input parameter.

Methods inherited from 1.1.1 OcaActuator: