DDS  ver. 3.6
Public Member Functions | Public Attributes | Friends | List of all members
dds::tools_api::SOnTaskDoneResponseData Struct Reference

Structure holds information of onTaskDone response. More...

#include <ToolsProtocol.h>

Inheritance diagram for dds::tools_api::SOnTaskDoneResponseData:
dds::tools_api::SBaseResponseData< T > dds::tools_api::SBaseData< T >

Public Member Functions

 SOnTaskDoneResponseData ()
 
 SOnTaskDoneResponseData (const boost::property_tree::ptree &_pt)
 
bool operator== (const SOnTaskDoneResponseData &_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

uint64_t m_taskID { 0 }
 Task ID. More...
 
uint32_t m_exitCode { 0 }
 Exit code. More...
 
uint32_t m_signal { 0 }
 A signal number if the process is killed by/stopped by a signal. More...
 
std::string m_host
 Hostname. More...
 
std::string m_wrkDir
 Working directory. More...
 
std::string m_taskPath
 Task path in the topology. More...
 
- Public Attributes inherited from dds::tools_api::SBaseData< T >
requestID_t m_requestID = 0
 

Friends

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

Detailed Description

Structure holds information of onTaskDone response.

Constructor & Destructor Documentation

◆ SOnTaskDoneResponseData() [1/2]

SOnTaskDoneResponseData::SOnTaskDoneResponseData ( )

◆ SOnTaskDoneResponseData() [2/2]

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

Member Function Documentation

◆ operator==()

bool SOnTaskDoneResponseData::operator== ( const SOnTaskDoneResponseData _val) const

Equality operator.

Friends And Related Function Documentation

◆ operator<<

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

Ostream operator.

Member Data Documentation

◆ m_exitCode

uint32_t dds::tools_api::SOnTaskDoneResponseData::m_exitCode { 0 }

Exit code.

◆ m_host

std::string dds::tools_api::SOnTaskDoneResponseData::m_host

Hostname.

◆ m_signal

uint32_t dds::tools_api::SOnTaskDoneResponseData::m_signal { 0 }

A signal number if the process is killed by/stopped by a signal.

◆ m_taskID

uint64_t dds::tools_api::SOnTaskDoneResponseData::m_taskID { 0 }

Task ID.

◆ m_taskPath

std::string dds::tools_api::SOnTaskDoneResponseData::m_taskPath

Task path in the topology.

◆ m_wrkDir

std::string dds::tools_api::SOnTaskDoneResponseData::m_wrkDir

Working directory.


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