OcaCommandSetAgent

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

Agent for immediate execution of commandsets.

This agent provides a mechanism for simple execution of commandsets in cases where the application does not require the more advanced storage and scheduling features provided by the OcaCommandSet, OcaTaskAgent, and OcaTaskScheduler classes.

---

Overview

• ClassID: 1.2.23
• Header: aes70/device/OcaCommandSetAgent.hpp
• Namespace: aes70::device
• Inheritance: aes70::device::OcaAgent, aes70::device::OcaRoot, aes70::device::object

Class Declaration

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaCommandSetAgent : 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 MyOcaCommandSetAgentImplementation
{
  // Methods defined by OcaCommandSetAgent
  OcaList32<OcaCommandResult> Execute(OcaList32<OcaCommand> Commands);

  // 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