DDS  ver. 3.5.3.8.g5fe284b
Public Member Functions | Public Attributes | List of all members
dds::intercom_api::SSubmit Struct Reference

Structure holds information of submit notification. More...

#include <Intercom.h>

Public Member Functions

 SSubmit ()
 Default constructor. More...
 
std::string toJSON ()
 Converts structure to JSON. More...
 
void fromJSON (const std::string &_json)
 Init structure from JSON. More...
 
void fromPT (const boost::property_tree::ptree &_pt)
 Init structure from boost's property tree. More...
 
bool operator== (const SSubmit &_val) const
 Equality operator. More...
 

Public Attributes

uint32_t m_nInstances
 A number of instances. More...
 
uint32_t m_slots
 A number of task slots. More...
 
std::string m_cfgFilePath
 Path to the configuration file. More...
 
std::string m_id
 ID for communication with DDS commander. More...
 
std::string m_wrkPackagePath
 A full path of the agent worker package, which needs to be deployed. More...
 

Detailed Description

Structure holds information of submit notification.

Constructor & Destructor Documentation

◆ SSubmit()

SSubmit::SSubmit ( )

Default constructor.

Member Function Documentation

◆ fromJSON()

void SSubmit::fromJSON ( const std::string &  _json)

Init structure from JSON.

Parameters
[in]_jsonJSON string with structure details.

◆ fromPT()

void SSubmit::fromPT ( const boost::property_tree::ptree &  _pt)

Init structure from boost's property tree.

Parameters
[in]_ptProperty tree with structure details.

◆ operator==()

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

Equality operator.

◆ toJSON()

std::string SSubmit::toJSON ( )

Converts structure to JSON.

Returns
String with JSON.

Member Data Documentation

◆ m_cfgFilePath

std::string dds::intercom_api::SSubmit::m_cfgFilePath

Path to the configuration file.

◆ m_id

std::string dds::intercom_api::SSubmit::m_id

ID for communication with DDS commander.

◆ m_nInstances

uint32_t dds::intercom_api::SSubmit::m_nInstances

A number of instances.

◆ m_slots

uint32_t dds::intercom_api::SSubmit::m_slots

A number of task slots.

◆ m_wrkPackagePath

std::string dds::intercom_api::SSubmit::m_wrkPackagePath

A full path of the agent worker package, which needs to be deployed.


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