pyclient.client.CcfCommands Class Reference

Class implementing the request interface with CCF Control. More...

Public Member Functions
def	__init__ (self, uri, timeout=60, check=False)
	uri Server MAL Request/Response URI (string). More...
def	check_if_valid_request (request)
	Check if the given request is defined and supported. More...
def	client (self, request)
	Get the proper client interface for the request. More...
def	execute_cmd (self, payload)
	Submit Execute command. More...
def	recstart_cmd (self, payload)
	Submit RecStart command. More...
def	recstatus_cmd (self, payload)
	Submit RecStatus command. More...
def	recstop_cmd (self, payload)
	Submit RecStop command. More...
def	recwait_cmd (self, payload)
	Submit RecWait command. More...
def	setloglevel_cmd (self, payload)
	Submit SetLogLevel command. More...
def	start_cmd (self, payload)
	Submit Start command. More...
def	send_cmd (self, request, payload)
	Send command to the associated server. More...

Static Public Attributes
dictionary	unsupported_requests
dictionary	int_to_cmds
dictionary	cmds_to_int = {}

Detailed Description

Class implementing the request interface with CCF Control.

Constructor & Destructor Documentation

__init__()

def pyclient.client.CcfCommands.__init__	(		self,
			uri,
			timeout = 60,
			check = False
	)

uri Server MAL Request/Response URI (string).

timeout Timeout in seconds, waiting for response (double). check Carry out request checking in the MAL interface (bool).

Member Function Documentation

check_if_valid_request()

def pyclient.client.CcfCommands.check_if_valid_request

(

request

)

Check if the given request is defined and supported.

Otherwise raise exception.

client()

def pyclient.client.CcfCommands.client	(		self,
			request
	)

Get the proper client interface for the request.

execute_cmd()

def pyclient.client.CcfCommands.execute_cmd	(		self,
			payload
	)

Submit Execute command.

recstart_cmd()

def pyclient.client.CcfCommands.recstart_cmd	(		self,
			payload
	)

Submit RecStart command.

recstatus_cmd()

def pyclient.client.CcfCommands.recstatus_cmd	(		self,
			payload
	)

Submit RecStatus command.

recstop_cmd()

def pyclient.client.CcfCommands.recstop_cmd	(		self,
			payload
	)

Submit RecStop command.

recwait_cmd()

def pyclient.client.CcfCommands.recwait_cmd	(		self,
			payload
	)

Submit RecWait command.

send_cmd()

def pyclient.client.CcfCommands.send_cmd	(		self,
			request,
			payload
	)

Send command to the associated server.

request Request to send e.g. "GetState" (string). payload Payload to send with the command (string|SPF|JPF). Returns Response from remote server (string).

setloglevel_cmd()

def pyclient.client.CcfCommands.setloglevel_cmd	(		self,
			payload
	)

Submit SetLogLevel command.

start_cmd()

def pyclient.client.CcfCommands.start_cmd	(		self,
			payload
	)

Submit Start command.

Member Data Documentation

cmds_to_int

dictionary pyclient.client.CcfCommands.cmds_to_int = {}

static

int_to_cmds

dictionary pyclient.client.CcfCommands.int_to_cmds

static

unsupported_requests

dictionary pyclient.client.CcfCommands.unsupported_requests

static

Initial value:

=  {
        "Abort": 0,
        "Execute": 0,
        "GetConfig": 0,
        "GetDiagnostics": 0,
        "GetDpData": 0,
        "GetSetup": 0,
        "ReadPars": 0,
        "Recover": 0,
        "SetConfig": 0,
        "WritePars": 0,
        "RecAbort": 0,
        "RecContinue": 0,
        "RecPause": 0,
    }

---

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

• tools/pycli/src/ifw/ccf/pyclient/client.py