1.1.1.11 OcaFilterPolynomial

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaFilterPolynomial

class OcaFilterPolynomial : OcaActuator

Generic Z-domain rational polynomial filter section with transfer function expression of the form: A(0) + A(1)z + A(2)z^2 + A(3)z^3 + … B(0) + B(1)z + B(2)z^2 + B(3)z^3 + …

Properties:

OcaList<OcaFloat32> A

Numerator - “A”

This property has id 4.1.

OcaList<OcaFloat32> B

Denominator - “B”

This property has id 4.2.

static const OcaClassID ClassID = "1.1.1.11"

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.

const OcaUint8 MaxOrder

Maximum order of A[] and B[], i.e. the maximum size of the A[] and B[] arrays. Readonly.

This property has id 4.4.

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 GetCoefficients(OcaList<OcaFloat32> &A, OcaList<OcaFloat32> &B)

Gets the polynomial coefficients.

This method has id 4.1.

  • A: Output parameter.

  • B: Output parameter.

OcaStatus SetCoefficients(OcaList<OcaFloat32> A, OcaList<OcaFloat32> B)

Sets the polynomial coefficients.

This method has id 4.2.

  • A: Input parameter.

  • B: Input parameter.

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

Gets the filter sampling rate value and limits.

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 GetMaxOrder(OcaUint8 &Order)

Gets the maximum allowable order (= max number of array elements in numerator and for denominator arrays)

This method has id 4.5.

  • Order: Output parameter.

Methods inherited from 1.1.1 OcaActuator: