Structure holds information of agentCommand request. More...

#include <ToolsProtocol.h>

Inheritance diagram for dds::tools_api::SAgentCommandRequestData:

Public Types
enum	EAgentCommandType : uint8_t { EAgentCommandType::shutDownByID = 0, EAgentCommandType::shutDownBySlotID }

Public Member Functions
	SAgentCommandRequestData ()

	SAgentCommandRequestData (const boost::property_tree::ptree &_pt)

bool	operator== (const SAgentCommandRequestData &_val) const
	Equality operator. More...

Public Member Functions inherited from dds::tools_api::SBaseData< SAgentCommandRequestData >
std::string	toJSON () const
	Fill structure into JSON. More...

void	toPT (boost::property_tree::ptree &_pt) const
	Fill structure into boost's property tree. More...

void	fromPT (const boost::property_tree::ptree &_pt)
	Init structure from boost's property tree. More...

bool	operator== (const SAgentCommandRequestData &_val) const
	Equality operator. More...

std::string	defaultToString () const
	Default string representation. More...

Public Attributes
EAgentCommandType	m_commandType = EAgentCommandType::shutDownByID

uint64_t	m_arg1 { 0 }
	argument #1 - numeric. The usage depends on the command. More...

std::string	m_arg2
	argument #1 - string. The usage depends on the command. More...

Public Attributes inherited from dds::tools_api::SBaseData< SAgentCommandRequestData >
requestID_t	m_requestID

Friends
std::ostream &	operator<< (std::ostream &_os, const SAgentCommandRequestData &_data)
	Ostream operator. More...

Detailed Description

Structure holds information of agentCommand request.

Member Enumeration Documentation

◆ EAgentCommandType

enum dds::tools_api::SAgentCommandRequestData::EAgentCommandType : uint8_t

strong

Enumerator
shutDownByID	m_arg1 should be set to a desired agent ID to shutdown
shutDownBySlotID	m_arg1 should be set to a desired slot ID. The corresponding agent holding this slot will be shutdown.

Constructor & Destructor Documentation

◆ SAgentCommandRequestData() [1/2]

SAgentCommandRequestData::SAgentCommandRequestData ( )

◆ SAgentCommandRequestData() [2/2]

SAgentCommandRequestData::SAgentCommandRequestData ( const boost::property_tree::ptree & _pt )

Member Function Documentation

◆ operator==()

bool SAgentCommandRequestData::operator== ( const SAgentCommandRequestData & _val ) const

Equality operator.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	_os,
		const SAgentCommandRequestData &	_data
	)

friend

Ostream operator.

Member Data Documentation

◆ m_arg1

uint64_t dds::tools_api::SAgentCommandRequestData::m_arg1 { 0 }

argument #1 - numeric. The usage depends on the command.

◆ m_arg2

std::string dds::tools_api::SAgentCommandRequestData::m_arg2

argument #1 - string. The usage depends on the command.

◆ m_commandType

EAgentCommandType dds::tools_api::SAgentCommandRequestData::m_commandType = EAgentCommandType::shutDownByID

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

Public Types

Public Member Functions

Public Attributes

Friends