RT::IScriptExecutorHelper Class Reference

Abstract class, defines interfaces to run and edit the robot's scripts. More...

Public Member Functions
virtual int	init (const std::string &conf_file_name)=0
virtual int	fini ()=0
virtual int	run_script (RobotHelperInterfacesProvider *sender, const std::string &script_name, const std::string &event_id, const std::string &params)=0
virtual int	get_script (const std::string &script_name, const std::string &stream)=0
virtual int	add_script (const std::string &script_name, const std::string &stream)=0
virtual int	remove_script (const std::string &script_name, const std::string &stream)=0

Detailed Description

Abstract class, defines interfaces to run and edit the robot's scripts.

virtual int RT::IScriptExecutorHelper::add_script	(	const std::string &	script_name,
		const std::string &	stream
	)			`[pure virtual]`

Add script to framework

script_name Script name stream in string (text of the script)

virtual int RT::IScriptExecutorHelper::fini ( ) [pure virtual]

Fini engine

virtual int RT::IScriptExecutorHelper::get_script	(	const std::string &	script_name,
		const std::string &	stream
	)			`[pure virtual]`

Get script as a string

script_name Wanted script stream out string (text of the script)

virtual int RT::IScriptExecutorHelper::init ( const std::string & conf_file_name ) [pure virtual]

Init engine with spesified file

virtual int RT::IScriptExecutorHelper::remove_script	(	const std::string &	script_name,
		const std::string &	stream
	)			`[pure virtual]`

Delete script from framework

virtual int RT::IScriptExecutorHelper::run_script	(	RobotHelperInterfacesProvider *	sender,
		const std::string &	script_name,
		const std::string &	event_id,
		const std::string &	params
	)			`[pure virtual]`

Run script

sender RobotHelperInterfacesProvider pointer, to provide callbacks handling script_name script to run event_id event id params additional parameters

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