1.1.1.13 OcaFilterArbitraryCurve

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaFilterArbitraryCurve

class OcaFilterArbitraryCurve : OcaActuator

An arbitrary-curve filter, with transfer function specified as amplitude and phase versus frequency.

Properties:

static const OcaClassID ClassID = "1.1.1.13"

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

static const OcaClassVersionNumber ClassVersion = 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.

This property has id 4.2.

OcaTransferFunction TransferFunction

Transfer function of the filter.

This property has id 4.1.

OcaFrequency SampleRate

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

This property has id 4.2.

OcaUint16 TFMinLength

Minimum number of points that transfer function must specify

This property has id 4.3.

OcaUint16 TFMaxLength

Maximum number of points that transfer function may specify

This property has id 4.4.

Properties inherited from OcaWorker:

• OcaBoolean OcaWorker::Enabled

• OcaList<OcaPort> OcaWorker::Ports

• OcaString OcaWorker::Label

• OcaONo OcaWorker::Owner

• OcaTimeInterval OcaWorker::Latency

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetTransferFunction(OcaTransferFunction &TransferFunction)

Returns the complex transfer function.

This method has id 4.1.

Parameters

OcaTransferFunction TransferFunction – Output parameter.

OcaStatus SetTransferFunction(OcaTransferFunction TransferFunction)

Sets the complex transfer function.

This method has id 4.2.

Parameters

OcaTransferFunction TransferFunction – Input parameter.

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

Gets the filter sampling rate.

This method has id 4.3.

Parameters

• OcaFrequency Rate – Output parameter.

• OcaFrequency minRate – Output parameter.

• OcaFrequency maxRate – Output parameter.

OcaStatus SetSampleRate(OcaFrequency Rate)

Sets the filter sampling rate.

This method has id 4.4.

Parameters

OcaFrequency Rate – Input parameter.

OcaStatus GetTFMinLength(OcaUint16 &Min)

Returns the minimum number of required points in the specified transfer function.

This method has id 4.5.

Parameters

OcaUint16 Min – Output parameter.

OcaStatus GetTFMaxLength(OcaUint16 &Max)

Returns the maximum number of allowed points in the specified transfer function.

This method has id 4.6.

Parameters

OcaUint16 Max – Output parameter.

Methods inherited from OcaWorker:

• OcaWorker::GetEnabled(enabled)

• OcaWorker::SetEnabled(enabled)

• OcaWorker::AddPort(Label, Mode, ID)

• OcaWorker::DeletePort(ID)

• OcaWorker::GetPorts(OcaPorts)

• OcaWorker::GetPortName(PortID, Name)

• OcaWorker::SetPortName(PortID, Name)

• OcaWorker::GetLabel(label)

• OcaWorker::SetLabel(label)

• OcaWorker::GetOwner(owner)

• OcaWorker::GetLatency(latency)

• OcaWorker::SetLatency(latency)

• OcaWorker::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()