hlcc::telif::SeqServerFacade Class Reference

#include <seqServerFacade.hpp>

Public Member Functions
	SeqServerFacade (std::string ip, std::string port, std::string script)
virtual	~SeqServerFacade ()
bool	IsConnected ()
void	SetObVariable (std::string var_name, std::string var_value)
void	SkipUserActions ()
void	SkipDefaultActions ()
void	RunScript ()
void	RunScriptInteractive ()
	SeqServerFacade (const SeqServerFacade &)=delete
SeqServerFacade &	operator= (const SeqServerFacade &)=delete
	Disable copy constructor.

Static Public Member Functions
static std::string	GetSeqServerIpPort ()
static std::pair< bool, std::string >	RunSeqScript (telifif::SequenceMode seq_mode, std::string script_name, std::optional< ObParams > ob=std::nullopt)
static std::string	GetHostIp ()

Constructor & Destructor Documentation

SeqServerFacade() [1/2]

hlcc::telif::SeqServerFacade::SeqServerFacade	(	std::string	ip,
		std::string	port,
		std::string	script )

Default Constructor Socket connection is created and engineering script is loaded in the server.

Parameters

[in]	ip	string, containing sequence server IP address
[in]	port	string, containing sequence server port
[in]	script	string, full path to engineering script to be loaded and executed

~SeqServerFacade()

hlcc::telif::SeqServerFacade::~SeqServerFacade ( )

virtual

Destructor Closes the socket connection

SeqServerFacade() [2/2]

hlcc::telif::SeqServerFacade::SeqServerFacade ( const SeqServerFacade & )

delete

Member Function Documentation

GetHostIp()

std::string hlcc::telif::SeqServerFacade::GetHostIp ( )

static

Get the Ip address of current machine

Returns

string, with ip address for given interface name. If any error happens return empty string.

GetSeqServerIpPort()

std::string hlcc::telif::SeqServerFacade::GetSeqServerIpPort ( )

static

Method used to get sequencer server ip and port

Returns

string with seq server ip and port

IsConnected()

bool hlcc::telif::SeqServerFacade::IsConnected

(

)

Queries if the connection to sequencer server was done.

Returns

bool, true if socket to Sequence Server is connected

operator=()

SeqServerFacade & hlcc::telif::SeqServerFacade::operator= ( const SeqServerFacade & )

delete

Disable copy constructor.

RunScript()

void hlcc::telif::SeqServerFacade::RunScript

(

)

Builds and sends to server command that will start the script execution

RunScriptInteractive()

void hlcc::telif::SeqServerFacade::RunScriptInteractive

(

)

Builds and sends to server command that will start the script execution in interactive mode, i.e. assuming a sequencer gui is attached to the sequencer server.

RunSeqScript()

std::pair< bool, std::string > hlcc::telif::SeqServerFacade::RunSeqScript ( telifif::SequenceMode seq_mode, std::string script_name, std::optional< ObParams > ob = std::nullopt )

static

Run given sequencer script with given mode and ob params

Parameters

seq_mode	sequence mode
script_name	script name to be run
ob	optional ob params

Returns

std::pair with bool and string. Bool indicates if call was successfull, if not string hold error msg,

SetObVariable()

void hlcc::telif::SeqServerFacade::SetObVariable	(	std::string	var_name,
		std::string	var_value )

Builds the command to Set the OB variable and sends it to sequencer server.

Parameters

[in]	var_name	string, name of the ob variable to be set.
[in]	var_value	string, correspondent value for the current variable to be set

SkipDefaultActions()

void hlcc::telif::SeqServerFacade::SkipDefaultActions

(

)

Builds command to flip skip all the steps identified as default action and sends commands to each step that must be skipped.

SkipUserActions()

void hlcc::telif::SeqServerFacade::SkipUserActions

(

)

Builds command to flip skip all the steps identified as user action (input) and sends commands to each step that must be skipped.

---

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

• /home/abuild/rpmbuild/BUILD/hlcc-v3.0.1/software/apps/telif/app/src/include/telif/seqServerFacade.hpp
• /home/abuild/rpmbuild/BUILD/hlcc-v3.0.1/software/apps/telif/app/src/seqServerFacade.cpp