1.1.1.9 OcaFilterClassical

Class Hierarchy:

OcaRoot : OcaWorker : OcaActuator : OcaFilterClassical

class OcaFilterClassical : OcaActuator 

Classical analog-style filter - highpass, lowpass, bandpass, etc., with shape characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley.

Properties:

static const OcaClassID ClassID = "1.1.1.9"

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 Frequency

The frequency of the filter.

This property has id 4.1.

OcaUint16 Order

Filter order

This property has id 4.4.

OcaFloat32 Parameter

Ripple or other filter parameter, depending on shape. Not used by some shapes.

This property has id 4.5.

OcaFilterPassband Passband

Lowpass, highpass, bandpass, bandreject

This property has id 4.2.

OcaClassicalFilterShape Shape

Shape family - Butterworth, Bessell, etc.

This property has id 4.3.

Properties inherited from 1.1.1 OcaActuator:

Methods:

OcaStatus GetFrequency(OcaFrequency &Frequency, OcaFrequency &minFrequency, OcaFrequency &maxFrequency)

Gets the value and limits of the Frequency property.

This method has id 4.1.

Frequency: Output parameter.
minFrequency: Output parameter.
maxFrequency: Output parameter.

OcaStatus SetFrequency(OcaFrequency frequency)

Sets the value of the Frequency property.

This method has id 4.2.

frequency: Input parameter.

OcaStatus GetPassband(OcaFilterPassband &Passband)

Gets the value of the Passband property.

This method has id 4.3.

Passband: Output parameter.

OcaStatus SetPassband(OcaFilterPassband Passband)

Sets the value of the Passband property.

This method has id 4.4.

Passband: Input parameter.

OcaStatus GetShape(OcaClassicalFilterShape &Shape)

Gets the value of the Shape property.

This method has id 4.5.

Shape: Output parameter.

OcaStatus SetShape(OcaClassicalFilterShape Shape)

Sets the value of the Shape property.

This method has id 4.6.

Shape: Input parameter.

OcaStatus GetOrder(OcaUint16 &Order, OcaUint16 &minOrder, OcaUint16 &maxOrder)

Gets the value and limits of the Order property.

This method has id 4.7.

Order: Output parameter.
minOrder: Output parameter.
maxOrder: Output parameter.

OcaStatus SetOrder(OcaUint16 Order)

Sets the value of the Order property.

This method has id 4.8.

Order: Input parameter.

OcaStatus GetParameter(OcaFloat32 &Parameter, OcaFloat32 &minParameter, OcaFloat32 &maxParameter)

Gets the value and limits of the Parameter property.

This method has id 4.9.

Parameter: Output parameter.
minParameter: Output parameter.
maxParameter: Output parameter.

OcaStatus SetParameter(OcaFloat32 Parameter)

Sets the value of the Parameter property.

This method has id 4.10.

Parameter: Input parameter.

OcaStatus SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaFilterPassband Passband, OcaClassicalFilterShape Shape, OcaUint16 Order, OcaFloat32 Parameter)

Sets some or all filter parameters. The action of this method shall be atomic - if any of the changes fails, none of the changes shall be made.

This method has id 4.11.

Mask: Input parameter.
Frequency: Input parameter.
Passband: Input parameter.
Shape: Input parameter.
Order: Input parameter.
Parameter: Input parameter.

Methods inherited from 1.1.1 OcaActuator: