Index

Class OcaFilterArbitraryCurve

ClassID: 1.1.1.13

extends OcaActuator

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

Properties

static readonly OcaClassID ClassID = 1.1.1.13

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.

OcaTransferFunction TransferFunction

Level: 4 Index: 1

Transfer function of the filter.

OcaFrequency SampleRate

Level: 4 Index: 2

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

OcaUint16 TFMinLength

Level: 4 Index: 3

Minimum number of points that transfer function must specify

OcaUint16 TFMaxLength

Level: 4 Index: 4

Maximum number of points that transfer function may specify

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

OcaFilterArbitraryCurve::GetTransferFunction ( ) → ( OcaTransferFunction TransferFunction)

Level: 4 Index: 1

Returns the complex transfer function.

OcaFilterArbitraryCurve::SetTransferFunction ( OcaTransferFunction TransferFunction )

Level: 4 Index: 2

Sets the complex transfer function.

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

Level: 4 Index: 3

Gets the filter sampling rate.

OcaFilterArbitraryCurve::SetSampleRate ( OcaFrequency Rate )

Level: 4 Index: 4

Sets the filter sampling rate.

OcaFilterArbitraryCurve::GetTFMinLength ( ) → ( OcaUint16 Min)

Level: 4 Index: 5

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

OcaFilterArbitraryCurve::GetTFMaxLength ( ) → ( OcaUint16 Max)

Level: 4 Index: 6

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

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 ( )