NanoOcp1::Ocp1CommandResponseRequired Class Reference

#include <Ocp1Message.h>

Inheritance diagram for NanoOcp1::Ocp1CommandResponseRequired:

Collaboration diagram for NanoOcp1::Ocp1CommandResponseRequired:

Public Member Functions
	Ocp1CommandResponseRequired (std::uint32_t targetOno, std::uint16_t methodDefLevel, std::uint16_t methodIndex, std::uint8_t paramCount, const ByteVector &parameterData)
	Ocp1CommandResponseRequired (std::uint32_t targetOno, std::uint16_t methodDefLevel, std::uint16_t methodIndex, std::uint8_t paramCount, const ByteVector &parameterData, std::uint32_t &handle)
	Ocp1CommandResponseRequired (const Ocp1CommandDefinition &def, std::uint32_t &handle)
	~Ocp1CommandResponseRequired () override=default
void	SetHandle (std::uint32_t handle)
std::uint32_t	GetHandle () const
std::uint32_t	GetTargetOno () const
std::uint16_t	GetMethodDefLevel () const
std::uint16_t	GetMethodIndex () const
ByteVector	GetSerializedData () override
Public Member Functions inherited from NanoOcp1::Ocp1Message
	Ocp1Message (std::uint8_t msgType, const ByteVector &parameterData)
virtual	~Ocp1Message ()=default
std::uint8_t	GetMessageType () const
ByteVector	GetParameterData () const

Protected Attributes
std::uint32_t	m_handle
std::uint32_t	m_targetOno
std::uint16_t	m_methodDefLevel
std::uint16_t	m_methodIndex
std::uint8_t	m_paramCount
Protected Attributes inherited from NanoOcp1::Ocp1Message
Ocp1Header	m_header
ByteVector	m_parameterData

Additional Inherited Members
Public Types inherited from NanoOcp1::Ocp1Message
enum	MessageType {   Command = 0 ,   CommandResponseRequired = 1 ,   Notification = 2 ,   Response = 3 ,   KeepAlive = 4 }
	OCP.1 message type codes as defined in AES70. More...
Static Public Member Functions inherited from NanoOcp1::Ocp1Message
static std::unique_ptr< Ocp1Message >	UnmarshalOcp1Message (const ByteVector &receivedData)
Static Protected Attributes inherited from NanoOcp1::Ocp1Message
static std::uint32_t	m_nextHandle = 2

Detailed Description

Representation of an OCA CommandResponseRequired message.

Definition at line 390 of file Ocp1Message.h.

Constructor & Destructor Documentation

Ocp1CommandResponseRequired() [1/3]

NanoOcp1::Ocp1CommandResponseRequired::Ocp1CommandResponseRequired ( std::uint32_t  targetOno, std::uint16_t  methodDefLevel, std::uint16_t  methodIndex, std::uint8_t  paramCount, const ByteVector &  parameterData  )

inline

Class constructor without creating the handle. To set the handle of this command, use SetHandle() after instantiation.

Definition at line 397 of file Ocp1Message.h.

Ocp1CommandResponseRequired() [2/3]

NanoOcp1::Ocp1CommandResponseRequired::Ocp1CommandResponseRequired ( std::uint32_t  targetOno, std::uint16_t  methodDefLevel, std::uint16_t  methodIndex, std::uint8_t  paramCount, const ByteVector &  parameterData, std::uint32_t &  handle  )

inline

Class constructor.

Definition at line 414 of file Ocp1Message.h.

References m_handle, and NanoOcp1::Ocp1Message::m_nextHandle.

Ocp1CommandResponseRequired() [3/3]

NanoOcp1::Ocp1CommandResponseRequired::Ocp1CommandResponseRequired ( const Ocp1CommandDefinition &  def, std::uint32_t &  handle  )

inline

Class constructor that takes parameters via a Ocp1CommandDefinition struct.

Definition at line 432 of file Ocp1Message.h.

~Ocp1CommandResponseRequired()

NanoOcp1::Ocp1CommandResponseRequired::~Ocp1CommandResponseRequired ( )

overridedefault

Class destructor.

Member Function Documentation

GetHandle()

std::uint32_t NanoOcp1::Ocp1CommandResponseRequired::GetHandle ( ) const

inline

Definition at line 454 of file Ocp1Message.h.

References m_handle.

GetMethodDefLevel()

std::uint16_t NanoOcp1::Ocp1CommandResponseRequired::GetMethodDefLevel ( ) const

inline

Definition at line 464 of file Ocp1Message.h.

References m_methodDefLevel.

GetMethodIndex()

std::uint16_t NanoOcp1::Ocp1CommandResponseRequired::GetMethodIndex ( ) const

inline

Definition at line 469 of file Ocp1Message.h.

References m_methodIndex.

GetSerializedData()

ByteVector NanoOcp1::Ocp1CommandResponseRequired::GetSerializedData ( )

overridevirtual

Returns a vector of bytes representing the binary contents of the complete message. Must be reimplemented for each message type.

Returns

A vector containing the OCA message including header.

Implements NanoOcp1::Ocp1Message.

Definition at line 344 of file Ocp1Message.cpp.

References NanoOcp1::Ocp1Header::GetMessageSize(), NanoOcp1::Ocp1Header::GetSerializedData(), m_handle, NanoOcp1::Ocp1Message::m_header, m_methodDefLevel, m_methodIndex, m_paramCount, NanoOcp1::Ocp1Message::m_parameterData, and m_targetOno.

Referenced by NanoOcp1Demo::MainComponent::MainComponent().

GetTargetOno()

std::uint32_t NanoOcp1::Ocp1CommandResponseRequired::GetTargetOno ( ) const

inline

Definition at line 459 of file Ocp1Message.h.

References m_targetOno.

SetHandle()

void NanoOcp1::Ocp1CommandResponseRequired::SetHandle ( std::uint32_t  handle )

inline

Override the automatically assigned command handle with a manually defined one.

Parameters

[in]

handle

New command handle to use.

Definition at line 449 of file Ocp1Message.h.

References m_handle.

Member Data Documentation

m_handle

std::uint32_t NanoOcp1::Ocp1CommandResponseRequired::m_handle

protected

Definition at line 479 of file Ocp1Message.h.

Referenced by GetHandle(), GetSerializedData(), Ocp1CommandResponseRequired(), and SetHandle().

m_methodDefLevel

std::uint16_t NanoOcp1::Ocp1CommandResponseRequired::m_methodDefLevel

protected

Definition at line 481 of file Ocp1Message.h.

Referenced by GetMethodDefLevel(), and GetSerializedData().

m_methodIndex

std::uint16_t NanoOcp1::Ocp1CommandResponseRequired::m_methodIndex

protected

Definition at line 482 of file Ocp1Message.h.

Referenced by GetMethodIndex(), and GetSerializedData().

m_paramCount

std::uint8_t NanoOcp1::Ocp1CommandResponseRequired::m_paramCount

protected

Definition at line 483 of file Ocp1Message.h.

Referenced by GetSerializedData().

m_targetOno

std::uint32_t NanoOcp1::Ocp1CommandResponseRequired::m_targetOno

protected

Definition at line 480 of file Ocp1Message.h.

Referenced by GetSerializedData(), and GetTargetOno().

---

The documentation for this class was generated from the following files:

• Source/Ocp1Message.h
• Source/Ocp1Message.cpp