Used to implement CCF Control client applications. More...

#include <dcsClient.hpp>

Inheritance diagram for ccf::common::DcsClient:

Public Member Functions
	DcsClient ()

	DcsClient (const std::string &service_uri)
	Instantiate the DCS Client, providing the reference to the associated CCF Control instance. More...

	~DcsClient ()

std::string	GenHelp (const std::string &application)
	Generate the help page as a string buffer. More...

std::string	GetInterfaceForRequest (const std::string &request)
	Return the interface, in which the given request is defined. More...

std::string	SendReq (const std::string &request, const core::utils::param::ParameterSet &parameters)
	Send the request to the associated CCF Control instance. More...

virtual std::string	SendReqUser (const std::string &request, const core::utils::param::ParameterSet &parameters)
	Method to actually send the request and receive the response. More...

std::string	SendReq (const std::string &request, const std::string &parameters)
	Send parameters provided in serialised format in a buffer or in a file to which there is referenced. More...

std::string	ExecuteShellCmd (int argc, char **argv)
	Parse the command line options given and send the request/receive the response. More...

Public Member Functions inherited from ccf::Base
	Base ()

	~Base ()

const std::string &	GetClassName () const
	Return the allocated name of the class. More...

log4cplus::Logger &	Loggger ()
	Return reference to logger used in this context. More...

Static Public Member Functions
static std::string	RecStatusToString (const std::shared_ptr< recif::RecStatus > &rec_status)
	Convert Recording Status number to string representaiton. More...

static std::string	RecWaitStatusToString (const std::shared_ptr< recif::RecWaitStatus > &rec_wait_status)
	Convert Recording Status string to number representaiton. More...

Static Public Member Functions inherited from ccf::Base
static ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton). More...

static void	SetLogLevel (const ccf::LogLevel log_level)
	Set the log level. More...

static ccf::LogLevel	GetLogLevel ()
	Return the current CCF log level. More...

Public Attributes
const std::map< std::string, std::vector< std::string > >	ITF_TO_REQ_MAP

Additional Inherited Members
Protected Member Functions inherited from ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question. More...

void	SetLogger (log4cplus::Logger &logger)
	Set reference to logger used in this context. More...

Protected Attributes inherited from ccf::Base
log4cplus::Logger	m_logger

Detailed Description

Used to implement CCF Control client applications.

Constructor & Destructor Documentation

◆ DcsClient() [1/2]

ccf::common::DcsClient::DcsClient ( )

◆ DcsClient() [2/2]

ccf::common::DcsClient::DcsClient ( const std::string & service_uri )

Instantiate the DCS Client, providing the reference to the associated CCF Control instance.

◆ ~DcsClient()

ccf::common::DcsClient::~DcsClient ( )

Member Function Documentation

◆ ExecuteShellCmd()

std::string ccf::common::DcsClient::ExecuteShellCmd	(	int	argc,
		char **	argv
	)

Parse the command line options given and send the request/receive the response.

◆ GenHelp()

std::string ccf::common::DcsClient::GenHelp ( const std::string & application )

Generate the help page as a string buffer.

◆ GetInterfaceForRequest()

std::string ccf::common::DcsClient::GetInterfaceForRequest ( const std::string & request )

Return the interface, in which the given request is defined.

◆ RecStatusToString()

std::string ccf::common::DcsClient::RecStatusToString ( const std::shared_ptr< recif::RecStatus > & rec_status )

static

Convert Recording Status number to string representaiton.

◆ RecWaitStatusToString()

std::string ccf::common::DcsClient::RecWaitStatusToString ( const std::shared_ptr< recif::RecWaitStatus > & rec_wait_status )

static

Convert Recording Status string to number representaiton.

◆ SendReq() [1/2]

std::string ccf::common::DcsClient::SendReq	(	const std::string &	request,
		const core::utils::param::ParameterSet &	parameters
	)

Send the request to the associated CCF Control instance.

◆ SendReq() [2/2]

std::string ccf::common::DcsClient::SendReq	(	const std::string &	request,
		const std::string &	parameters
	)

Send parameters provided in serialised format in a buffer or in a file to which there is referenced.

◆ SendReqUser()

std::string ccf::common::DcsClient::SendReqUser	(	const std::string &	request,
		const core::utils::param::ParameterSet &	parameters
	)

virtual

Method to actually send the request and receive the response.

Reimplemented in ccf::common::test::DcsClientTest.

Member Data Documentation

◆ ITF_TO_REQ_MAP

const std::map<std::string, std::vector<std::string> > ccf::common::DcsClient::ITF_TO_REQ_MAP

Initial value:

= {
      {"StdCmds", {"Disable", "Enable", "Exit", "GetState", "GetStatus", "GetVersion", 
                   "Init", "Reset", "SetLogLevel", "Stop"}},
      {"DcsCmds", {"Abort", "Execute", "GetConfig", "GetDiagnostics", "GetDpData", "GetSetup",
                   "Ping", "ReadPars", "Recover", "Scan", "SetConfig", "Setup", "Start", "WritePars"}},
      {"RecCmds", {"RecAbort", "RecContinue", "RecPause", "RecStart", "RecStatus", "RecStop", "RecWait"}}
    }

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

common/src/include/ccf/common/dcsClient.hpp
common/src/dcsClient.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members