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

Structure holds information of topology response - activated and stopped tasks. More...

#include <ToolsProtocol.h>

Inheritance diagram for dds::tools_api::STopologyResponseData:
dds::tools_api::SBaseResponseData< STopologyResponseData > dds::tools_api::SBaseData< STopologyResponseData >

Public Member Functions

 STopologyResponseData ()
 
 STopologyResponseData (const boost::property_tree::ptree &_pt)
 
bool operator== (const STopologyResponseData &_val) const
 Equality operator. More...
 
- Public Member Functions inherited from dds::tools_api::SBaseData< STopologyResponseData >
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 STopologyResponseData &_val) const
 Equality operator. More...
 
std::string defaultToString () const
 Default string representation. More...
 

Public Attributes

bool m_activated { true }
 True if task was activated, otherwise it's stopped. More...
 
uint64_t m_agentID { 0 }
 Agent ID. More...
 
uint64_t m_slotID { 0 }
 Slot ID. More...
 
uint64_t m_taskID { 0 }
 Task ID, 0 if not assigned. More...
 
uint64_t m_collectionID { 0 }
 Collection ID, 0 if not in a collection. More...
 
std::string m_path
 Path in the topology. More...
 
std::string m_host
 Hostname. More...
 
std::string m_wrkDir
 Wrk directory. More...
 
- Public Attributes inherited from dds::tools_api::SBaseData< STopologyResponseData >
requestID_t m_requestID
 

Friends

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

Detailed Description

Structure holds information of topology response - activated and stopped tasks.

Constructor & Destructor Documentation

◆ STopologyResponseData() [1/2]

STopologyResponseData::STopologyResponseData ( )

◆ STopologyResponseData() [2/2]

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

Member Function Documentation

◆ operator==()

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

Equality operator.

Friends And Related Function Documentation

◆ operator<<

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

Ostream operator.

Member Data Documentation

◆ m_activated

bool dds::tools_api::STopologyResponseData::m_activated { true }

True if task was activated, otherwise it's stopped.

◆ m_agentID

uint64_t dds::tools_api::STopologyResponseData::m_agentID { 0 }

Agent ID.

◆ m_collectionID

uint64_t dds::tools_api::STopologyResponseData::m_collectionID { 0 }

Collection ID, 0 if not in a collection.

◆ m_host

std::string dds::tools_api::STopologyResponseData::m_host

Hostname.

◆ m_path

std::string dds::tools_api::STopologyResponseData::m_path

Path in the topology.

◆ m_slotID

uint64_t dds::tools_api::STopologyResponseData::m_slotID { 0 }

Slot ID.

◆ m_taskID

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

Task ID, 0 if not assigned.

◆ m_wrkDir

std::string dds::tools_api::STopologyResponseData::m_wrkDir

Wrk directory.


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