A classical analog-style filter - highpass, lowpass, bandpass, etc., with shape characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley. Frequently used in loudspeaker crossover networks.
static
readonly
OcaClassID ClassID
= 1.1.1.9
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.
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.
Level: 4 Index: 1
The frequency of the filter.
Level: 4 Index: 2
Lowpass, highpass, bandpass, bandreject
Level: 4 Index: 3
Shape family - Butterworth, Bessell, etc.
Level: 4 Index: 4
Filter order
Level: 4 Index: 5
Ripple or other filter parameter, depending on shape. Not used by some shapes.
Properties inherited from OcaWorker
Properties inherited from OcaRoot
OcaFilterClassical::GetFrequency (
)
→ (
OcaFrequency Frequency, OcaFrequency minFrequency, OcaFrequency maxFrequency)
Level: 4 Index: 1
Gets the value of the Frequency property. The return value indicates if the property was successfully retrieved.
OcaFilterClassical::SetFrequency (
OcaFrequency frequency )
Level: 4 Index: 2
Sets the value of the Frequency property. The return value indicates if the property was successfully set.
OcaFilterClassical::GetPassband (
)
→ (
OcaFilterPassband Passband)
Level: 4 Index: 3
Returns the passband specification of the filter object. The return value indicates if the specification was successfully retrieved.
OcaFilterClassical::SetPassband (
OcaFilterPassband Passband )
Level: 4 Index: 4
Sets the passband specification of the filter object. The return value indicates if the specification was successfully set.
Level: 4 Index: 5
Returns the Shape property of the filter. The return value indicates if the property was successfully retrieved.
Level: 4 Index: 6
Sets the Shape property of the filter. The return value indicates if the property was successfully set.
OcaFilterClassical::GetOrder (
)
→ (
OcaUint16 Order, OcaUint16 minOrder, OcaUint16 maxOrder)
Level: 4 Index: 7
Returns the order of the filter. The return value indicates if the property was successfully retrieved.
OcaFilterClassical::SetOrder (
OcaUint16 Order )
Level: 4 Index: 8
Sets the order of the filter. The return value indicates if the property was successfully set.
OcaFilterClassical::GetParameter (
)
→ (
OcaFloat32 Parameter, OcaFloat32 minParameter, OcaFloat32 maxParameter)
Level: 4 Index: 9
Returns the filter parameter. The return value indicates if the property was successfully retrieved.
OcaFilterClassical::SetParameter (
OcaFloat32 Parameter )
Level: 4 Index: 10
Sets the filter parameter. The return value indicates if the parameter was successfully set.
Level: 4 Index: 11
Sets some or all filter parameter. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.