DDS  ver. 3.4
Public Member Functions | Public Attributes | Friends | List of all members
dds::tools_api::SBaseData< T > Struct Template Reference

#include <ToolsProtocolCore.h>

Inheritance diagram for dds::tools_api::SBaseData< T >:
dds::tools_api::SBaseRequestData< T > dds::tools_api::SBaseResponseData< T > dds::tools_api::SAgentCountResponseData dds::tools_api::SAgentInfoResponseData dds::tools_api::SCommanderInfoResponseData dds::tools_api::SProgressResponseData

Public Member Functions

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

requestID_t m_requestID = 0
 

Friends

std::ostream & operator<< (std::ostream &_os, const SBaseData &_data)
 Stream operator. More...
 

Member Function Documentation

◆ defaultToString()

template<class T>
std::string dds::tools_api::SBaseData< T >::defaultToString ( ) const
inline

Default string representation.

◆ fromPT()

template<class T>
void dds::tools_api::SBaseData< T >::fromPT ( const boost::property_tree::ptree &  _pt)
inline

Init structure from boost's property tree.

Parameters
[in]_ptProperty tree with structure details.

◆ operator==()

template<class T>
bool dds::tools_api::SBaseData< T >::operator== ( const T &  _val) const
inline

Equality operator.

◆ toJSON()

template<class T>
std::string dds::tools_api::SBaseData< T >::toJSON ( ) const
inline

Fill structure into JSON.

Returns
a JSON-formatted string

◆ toPT()

template<class T>
void dds::tools_api::SBaseData< T >::toPT ( boost::property_tree::ptree &  _pt) const
inline

Fill structure into boost's property tree.

Parameters
[out]_ptProperty tree with structure details.

Friends And Related Function Documentation

◆ operator<<

template<class T>
std::ostream& operator<< ( std::ostream &  _os,
const SBaseData< T > &  _data 
)
friend

Stream operator.

Member Data Documentation

◆ m_requestID

template<class T>
requestID_t dds::tools_api::SBaseData< T >::m_requestID = 0

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