Skip to content

OcaFilterClassical#

This document describes the device side implementation of OcaFilterClassical. This class is documented in the AES70 standard as:

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

Overview#

Class Declaration#

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaFilterClassical : public OcaActuator<Implementation>
  {

  };
}

The template argument Implementation may implement the following methods.

Note

The signatures given here are just one possibility and that most methods are optional. Implement only those methods which make sense in the context of your device. See the documentation in Implementing AES70 Classes for more details.

class MyOcaFilterClassicalImplementation
{
  // Methods defined by OcaFilterClassical
  std::tuple<OcaFrequency,OcaFrequency,OcaFrequency> GetFrequency();
  void SetFrequency(OcaFrequency frequency);
  OcaFilterPassband GetPassband();
  void SetPassband(OcaFilterPassband Passband);
  OcaClassicalFilterShape GetShape();
  void SetShape(OcaClassicalFilterShape Shape);
  std::tuple<OcaUint16,OcaUint16,OcaUint16> GetOrder();
  void SetOrder(OcaUint16 Order);
  std::tuple<OcaFloat32,OcaFloat32,OcaFloat32> GetParameter();
  void SetParameter(OcaFloat32 Parameter);
  void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaFilterPassband Passband, OcaClassicalFilterShape Shape, OcaUint16 Order, OcaFloat32 Parameter);

  // Methods defined by OcaWorker
  OcaBoolean GetEnabled();
  void SetEnabled(OcaBoolean enabled);
  OcaPortID AddPort(OcaString Name, OcaIODirection Mode);
  void DeletePort(OcaPortID ID);
  OcaList<OcaPort> GetPorts();
  OcaString GetPortName(OcaPortID PortID);
  void SetPortName(OcaPortID ID, OcaString Name);
  OcaString GetLabel();
  void SetLabel(OcaString label);
  OcaONo GetOwner();
  OcaTimeInterval GetLatency();
  void SetLatency(OcaTimeInterval latency);
  std::tuple<OcaRolePath,OcaONoPath> GetPath();
  OcaMap<OcaPortID, OcaPortClockMapEntry> GetPortClockMap();
  void SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map);
  OcaPortClockMapEntry GetPortClockMapEntry(OcaPortID ID);
  void SetPortClockMapEntry(OcaPortID PortID, OcaPortClockMapEntry Entry);
  void DeletePortClockMapEntry(OcaPortID ID);

  // Methods defined by OcaRoot
  OcaBoolean GetLockable();
  void SetLockNoReadWrite();
  void Unlock();
  OcaString GetRole();
  void SetLockNoWrite();
  OcaLockState GetLockState();

};

Events#