Skip to content

OcaGroup#

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

Control aggregator. See [AES70-1(Control Aggregation)] for the normative specification of OcaGroup semantics.


Overview#

Class Declaration#

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaGroup : public OcaAgent<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 MyOcaGroupImplementation
{
  // Methods defined by OcaGroup
  OcaList<OcaONo> GetMembers();
  void SetMembers(OcaList<OcaONo> Members);
  void AddMember(OcaONo Member);
  void RemoveMember(OcaONo Member);
  OcaONo GetGroupControllerONo();
  void SetGroupControllerONo(OcaONo ONo);
  OcaString GetAggregationRule();
  void SetAggregationRule(OcaString Rule);
  OcaString GetSaturationRule();
  void SetSaturationRule(OcaString Rule);

  // Methods defined by OcaAgent
  OcaString GetLabel();
  void SetLabel(OcaString Label);
  OcaONo GetOwner();
  std::tuple<OcaRolePath,OcaONoPath> GetPath();

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

};

Events#