Structure holds information of topology request. More...
#include <ToolsProtocol.h>
Inheritance diagram for dds::tools_api::STopologyRequestData:
Public Types | |
| enum | EUpdateType : uint8_t { EUpdateType::UPDATE = 0, EUpdateType::ACTIVATE, EUpdateType::STOP } |
Public Member Functions | |
| STopologyRequestData () | |
| STopologyRequestData (const boost::property_tree::ptree &_pt) | |
| bool | operator== (const STopologyRequestData &_val) const |
| Equality operator. More... | |
 Public Member Functions inherited from dds::tools_api::SBaseData< STopologyRequestData > | |
| 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 STopologyRequestData &_val) const |
| Equality operator. More... | |
| std::string | defaultToString () const |
| Default string representation. More... | |
Public Attributes | |
| EUpdateType | m_updateType = EUpdateType::UPDATE |
| Topology update type: Update, Activate, Stop. More... | |
| std::string | m_topologyFile |
| A topology file to process. More... | |
| bool | m_disableValidation = false |
| A flag to disiable topology validation before processing it. More... | |
| Public Attributes inherited from dds::tools_api::SBaseData< STopologyRequestData > | |
| requestID_t | m_requestID |
Friends | |
| std::ostream & | operator<< (std::ostream &_os, const STopologyRequestData &_data) |
| Ostream operator. More... | |
Detailed Description
Structure holds information of topology request.
Member Enumeration Documentation
◆ EUpdateType
|
strong |
Constructor & Destructor Documentation
◆ STopologyRequestData() [1/2]
| STopologyRequestData::STopologyRequestData | ( | ) |
◆ STopologyRequestData() [2/2]
| STopologyRequestData::STopologyRequestData | ( | const boost::property_tree::ptree & | _pt | ) |
Member Function Documentation
◆ operator==()
| bool STopologyRequestData::operator== | ( | const STopologyRequestData & | _val | ) | const |
Equality operator.
Friends And Related Function Documentation
◆ operator<<
|
friend |
Ostream operator.
Member Data Documentation
◆ m_disableValidation
| bool dds::tools_api::STopologyRequestData::m_disableValidation = false |
A flag to disiable topology validation before processing it.
◆ m_topologyFile
| std::string dds::tools_api::STopologyRequestData::m_topologyFile |
A topology file to process.
◆ m_updateType
| EUpdateType dds::tools_api::STopologyRequestData::m_updateType = EUpdateType::UPDATE |
Topology update type: Update, Activate, Stop.
The documentation for this struct was generated from the following files:
