template<class Class>

aes70::device::OcaRamper class

Template parameters
Class	- Class to wrap.

This class template detects the methods and events defined for the class OcaRamper in the AES70 specification and exposes them through AES70. Note that all AES70 methods and event handlers need to be public in order to be detected.

Detects the following symbols with the corresponding detector classes:

• Control : aes70::device::Method

  Arguments:

  • Command : OcaRamperCommand

• GetState : aes70::device::Getter

  Return values:

  • State : OcaRamperState

• GetRampedProperty : aes70::device::Getter

  Return values:

  • property : OcaProperty

• SetRampedProperty : aes70::device::Setter

  Arguments:

  • property : OcaProperty

• GetTimeMode : aes70::device::Getter

  Return values:

  • TimeMode : OcaTimeMode

• SetTimeMode : aes70::device::Setter

  Arguments:

  • TimeMode : OcaTimeMode

• GetStartTime : aes70::device::Getter

  Return values:

  • StartTime : OcaUint64

• SetStartTime : aes70::device::Setter

  Arguments:

  • TimeMode : OcaUint64

• GetDuration : aes70::device::Getter

  Return values:

  • Duration : OcaFloat32
  • miinDuration : OcaFloat32
  • maxDuration : OcaFloat32

• SetDuration : aes70::device::Setter

  Arguments:

  • Duration : OcaFloat32

• GetInterpolationLaw : aes70::device::Getter

  Return values:

  • law : OcaRamperInterpolationLaw

• SetInterpolationLaw : aes70::device::Setter

  Arguments:

  • law : OcaRamperInterpolationLaw

• GetGoal : aes70::device::Getter

  Return values:

  • goal : OcaFloat64

• SetGoal : aes70::device::Setter

  Arguments:

  • goal : OcaFloat64

Detects the following event handlers for property changes (of type aes70::property_change_event ):

• OnStateChanged with property encoder OCP1::OcaUint8
• OnRampedPropertyChanged with property encoder OCP1::Struct<OCP1::OcaUint32, OCP1::Struct<OCP1::Struct<OCP1::OcaUint16, OCP1::OcaUint16>, OCP1::OcaUint8, OCP1::Struct<OCP1::OcaUint16, OCP1::OcaUint16>, OCP1::Struct<OCP1::OcaUint16, OCP1::OcaUint16>>>
• OnTimeModeChanged with property encoder OCP1::OcaUint8
• OnStartTimeChanged with property encoder OCP1::OcaUint64
• OnDurationChanged with property encoder OCP1::OcaFloat32
• OnInterpolationLawChanged with property encoder OCP1::OcaUint8
• OnGoalChanged with property encoder OCP1::OcaFloat64

From the AES70 standard:

Agent that gradually changes a property setting from one value to another. Works on a scalar numeric or boolean property of a specified object. Does not work for array, list, map, struct, or string properties. Contains timer features to allow ramps to start immediately or at any time in the future. This is a weakly typed class. All ramping parameters are specified as a OcaFloat64 numbers.

• For unsigned integer targets, the ramping parameters are coerced to OcaUint64 before comparing.
• For signed integer targets, the ramping parameters are coerced to OcaInt64 before comparing.
• For boolean values, the the ramping parameters are coerced to OcaUint8. True is assigned the value One, False is assigned the value Zero.

Base classes

template<class Class>

class OcaAgent

Public static variables

static const OcaClassVersionNumber ClassVersion

static const classid_tpl<3> ClassId

static const size_t count_events

Public static functions

static auto get_event_index(OcaEventID id, size_t index) -> AES70_ALWAYS_INLINE ptrdiff_t

Constructors, destructors, conversion operators

template<typename ... TN>

OcaRamper(TN && ... args)

Public functions

auto get_class_version() const -> uint16_t virtual

auto get_classid() const -> const classid& virtual

void init(aes70::device::device* d, uint32_t n) virtual

auto call(const OcaMethodID id, const uint8_t* src, const uint8_t* src_end, uint8_t parameterCount, const aes70::response_generator& response) -> bool virtual

auto get_event_index(const OcaEventID OcaEventID) const -> ptrdiff_t virtual

Function documentation

template<classClass>

static AES70_ALWAYS_INLINE ptrdiff_t aes70::device::OcaRamper<Class>::get_event_index(OcaEventID id, size_t index)

Internal class for finding the event index of a given EventID. Returns -1 if the given event is not defined.

template<classClass> template<typename ... TN>

aes70::device::OcaRamper<Class>::OcaRamper(TN && ... args)

Constructor which calls the constructor of Class with args forwarded.

template<classClass>

uint16_t aes70::device::OcaRamper<Class>::get_class_version() const virtual

Returns the AES70 class version of this object.

template<classClass>

const classid& aes70::device::OcaRamper<Class>::get_classid() const virtual

Returns the AES70 class id of this object.

template<classClass>

void aes70::device::OcaRamper<Class>::init(aes70::device::device* d, uint32_t n) virtual

Called when this object is added to a device.

template<classClass>

bool aes70::device::OcaRamper<Class>::call(const OcaMethodID id, const uint8_t* src, const uint8_t* src_end, uint8_t parameterCount, const aes70::response_generator& response) virtual

Internal method used to call AES70 methods in this object.

template<classClass>

ptrdiff_t aes70::device::OcaRamper<Class>::get_event_index(const OcaEventID OcaEventID) const virtual

Returns the index of a given event. The idea is that all events defined on a aes70 class can be enumerated. For events which this object does not implement, the value -1 is returned.

Variable documentation

template<classClass>

static const OcaClassVersionNumber aes70::device::OcaRamper<Class>::ClassVersion

The ClassVersion of this class according to the AES70 standard.

template<classClass>

static const classid_tpl<3> aes70::device::OcaRamper<Class>::ClassId

The ClassID of this class according to the AES70 standard.

template<classClass>

static const size_t aes70::device::OcaRamper<Class>::count_events

Number of events defined in this class. This depends on which events are implemented by Class.