Index

Class OcaFilterPolynomial

ClassID: 1.1.1.11

extends OcaActuator

A generic Z-domain rational polynomial filter section: 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

static readonly OcaClassID ClassID = 1.1.1.11

Level: 1 Index: 1

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.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 2

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.

OcaList<OcaFloat32> A

Level: 4 Index: 1

Numerator - "A"

OcaList<OcaFloat32> B

Level: 4 Index: 2

Denominator - "B"

OcaFrequency SampleRate

Level: 4 Index: 3

Sample rate inside the filter. We can't assume it's the same as the device input or output rate.

readonly OcaUint8 MaxOrder

Level: 4 Index: 4

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

Properties inherited from OcaWorker

OcaBoolean Enabled

OcaList<OcaPort> Ports

OcaString Label

OcaONo Owner

OcaTimeInterval Latency

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaFilterPolynomial::GetCoefficients ( ) → ( OcaList<OcaFloat32> A, OcaList<OcaFloat32> B)

Level: 4 Index: 1

Returns the polynomial coefficients used.

OcaFilterPolynomial::SetCoefficients ( OcaList<OcaFloat32> A, OcaList<OcaFloat32> B )

Level: 4 Index: 2

Sets the polynomial coefficients.

OcaFilterPolynomial::GetSampleRate ( ) → ( OcaFrequency Rate, OcaFrequency minRate, OcaFrequency maxRate)

Level: 4 Index: 3

Gets the filter sampling rate.

OcaFilterPolynomial::SetSampleRate ( OcaFrequency Rate )

Level: 4 Index: 4

Sets the filter sampling rate.

OcaFilterPolynomial::GetMaxOrder ( ) → ( OcaUint8 Order)

Level: 4 Index: 5

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

Methods inherited from OcaWorker

OcaWorker::GetEnabled ( ) → ( OcaBoolean enabled)

OcaWorker::SetEnabled ( OcaBoolean enabled )

OcaWorker::AddPort ( OcaString Label, OcaPortMode Mode ) → ( OcaPortID ID)

OcaWorker::DeletePort ( OcaPortID ID )

OcaWorker::GetPorts ( ) → ( OcaList<OcaPort> OcaPorts)

OcaWorker::GetPortName ( OcaPortID PortID ) → ( OcaString Name)

OcaWorker::SetPortName ( OcaPortID PortID, OcaString Name )

OcaWorker::GetLabel ( ) → ( OcaString label)

OcaWorker::SetLabel ( OcaString label )

OcaWorker::GetOwner ( ) → ( OcaONo owner)

OcaWorker::GetLatency ( ) → ( OcaTimeInterval latency)

OcaWorker::SetLatency ( OcaTimeInterval latency )

OcaWorker::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )