DDS  ver. 3.6
Classes | Typedefs | Functions
dds::tools_api Namespace Reference

Classes

class  CSession
 The main class of the Tools API. It represets a DDS session. More...
 
struct  SAgentCommandRequestData
 Structure holds information of agentCommand request. More...
 
struct  SAgentCountResponseData
 Structure holds information of agentCount response. More...
 
struct  SAgentInfoResponseData
 Structure holds information of agentInfo response. More...
 
struct  SBaseData
 
struct  SBaseRequestData
 
struct  SBaseRequestImpl
 
struct  SBaseResponseData
 
struct  SCommanderInfoResponseData
 Structure holds information of commanderInfo response. More...
 
struct  SEmptyResponseData
 
struct  SOnTaskDoneResponseData
 Structure holds information of onTaskDone response. More...
 
struct  SProgressResponseData
 Structure holds information of a done response. More...
 
struct  SSlotInfoResponseData
 Structure holds information of slot info response. More...
 
struct  SSubmitRequestData
 Structure holds information of a submit request. More...
 
struct  STopologyRequestData
 Structure holds information of topology request. More...
 
struct  STopologyResponseData
 Structure holds information of topology response - activated and stopped tasks. More...
 

Typedefs

using SSubmitRequest = SBaseRequestImpl< SSubmitRequestData, SEmptyResponseData >
 Request class of submit. More...
 
using STopologyRequest = SBaseRequestImpl< STopologyRequestData, STopologyResponseData >
 Request class of topology. More...
 
using SAgentCommandRequest = SBaseRequestImpl< SAgentCommandRequestData, SEmptyResponseData >
 Request class of submit. More...
 
typedef uint64_t requestID_t
 

Functions

std::ostream & operator<< (std::ostream &_os, const SProgressResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SMessageResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SSubmitRequestData &_data)
 
std::ostream & operator<< (std::ostream &_os, const STopologyRequestData &_data)
 
std::ostream & operator<< (std::ostream &_os, const STopologyResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SCommanderInfoResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SAgentInfoResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SSlotInfoResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SAgentCountResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SOnTaskDoneResponseData &_data)
 
std::ostream & operator<< (std::ostream &_os, const SAgentCommandRequestData &_data)
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SGetLogRequestData, "getlog") using SGetLogRequest
 Structure holds information of a getlog request. More...
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SCommanderInfoRequestData, "commanderInfo") using SCommanderInfoRequest
 Structure holds information of a commanderInfo request. More...
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SAgentInfoRequestData, "agentInfo") using SAgentInfoRequest
 Structure holds information of agentInfo request. More...
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SSlotInfoRequestData, "slotInfo") using SSlotInfoRequest
 Structure holds information of slottInfo request. More...
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SAgentCountRequestData, "agentCount") using SAgentCountRequest
 Structure holds information of agentCount response. More...
 
 DDS_TOOLS_DECLARE_DATA_CLASS (SBaseRequestData, SOnTaskDoneRequestData, "onTaskDone") using SOnTaskDoneRequest
 Structure holds information of onTaskDone response. More...
 

Typedef Documentation

◆ requestID_t

typedef uint64_t dds::tools_api::requestID_t

◆ SAgentCommandRequest

Request class of submit.

◆ SSubmitRequest

Request class of submit.

◆ STopologyRequest

Request class of topology.

Function Documentation

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [1/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SGetLogRequestData  ,
"getlog"   
)

Structure holds information of a getlog request.

Request class of getlog.

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [2/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SCommanderInfoRequestData  ,
"commanderInfo"   
)

Structure holds information of a commanderInfo request.

Request class of commanderInfo.

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [3/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SAgentInfoRequestData  ,
"agentInfo"   
)

Structure holds information of agentInfo request.

Request class of agentInfo.

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [4/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SSlotInfoRequestData  ,
"slotInfo"   
)

Structure holds information of slottInfo request.

Request class of agentInfo.

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [5/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SAgentCountRequestData  ,
"agentCount"   
)

Structure holds information of agentCount response.

Request class of agentCount.

◆ DDS_TOOLS_DECLARE_DATA_CLASS() [6/6]

dds::tools_api::DDS_TOOLS_DECLARE_DATA_CLASS ( SBaseRequestData  ,
SOnTaskDoneRequestData  ,
"onTaskDone"   
)

Structure holds information of onTaskDone response.

Request class of onTaskDone.

◆ operator<<() [1/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SProgressResponseData _data 
)

◆ operator<<() [2/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SMessageResponseData &  _data 
)

◆ operator<<() [3/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SSubmitRequestData _data 
)

◆ operator<<() [4/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const STopologyRequestData _data 
)

◆ operator<<() [5/11]

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

◆ operator<<() [6/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SCommanderInfoResponseData _data 
)

◆ operator<<() [7/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SAgentInfoResponseData _data 
)

◆ operator<<() [8/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SSlotInfoResponseData _data 
)

◆ operator<<() [9/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SAgentCountResponseData _data 
)

◆ operator<<() [10/11]

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

◆ operator<<() [11/11]

std::ostream& dds::tools_api::operator<< ( std::ostream &  _os,
const SAgentCommandRequestData _data 
)