Structure holds information of a done response. More...

#include <ToolsProtocol.h>

Inheritance diagram for dds::tools_api::SProgressResponseData:

Public Member Functions
	SProgressResponseData ()

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

	SProgressResponseData (uint16_t _srcCmd, uint32_t _completed, uint32_t _total, uint32_t _errors, uint32_t _time=0)

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

Public Member Functions inherited from dds::tools_api::SBaseData< T >
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 T &_val) const
	Equality operator. More...

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

Public Attributes
uint32_t	m_completed = 0

uint32_t	m_total = 0

uint32_t	m_errors = 0

uint32_t	m_time = 0

uint16_t	m_srcCommand = 0
	Reserved for internal use. More...

Public Attributes inherited from dds::tools_api::SBaseData< T >
requestID_t	m_requestID = 0

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

Detailed Description

Structure holds information of a done response.

Structure holds information of a message response. Structure holds information of a progress response.

Constructor & Destructor Documentation

◆ SProgressResponseData() [1/3]

SProgressResponseData::SProgressResponseData ( )

◆ SProgressResponseData() [2/3]

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

◆ SProgressResponseData() [3/3]

SProgressResponseData::SProgressResponseData	(	uint16_t	_srcCmd,
		uint32_t	_completed,
		uint32_t	_total,
		uint32_t	_errors,
		uint32_t	_time = `0`
	)

Member Function Documentation

◆ operator==()

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

Equality operator.

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream operator.

Member Data Documentation

◆ m_completed

uint32_t dds::tools_api::SProgressResponseData::m_completed = 0

◆ m_errors

uint32_t dds::tools_api::SProgressResponseData::m_errors = 0

◆ m_srcCommand

uint16_t dds::tools_api::SProgressResponseData::m_srcCommand = 0

Reserved for internal use.

◆ m_time

uint32_t dds::tools_api::SProgressResponseData::m_time = 0

◆ m_total

uint32_t dds::tools_api::SProgressResponseData::m_total = 0

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

Public Member Functions

Public Attributes

Friends