ProgramLoader Class Reference

#include <rtt/scripting/ProgramLoader.hpp>

List of all members.

---

Detailed Description

This class loads and unloads Orocos Program Script and Orocos State Description files to a TaskContext's Processor.

It wraps around Parser and can process both files and C++ streams. Parse exceptions are directed to the Logger class or rethrown if requested by the user.

Definition at line 55 of file ProgramLoader.hpp.

Public Types
typedef std::vector < ProgramInterfacePtr >	Functions
	List of executed functions.
Public Member Functions
	ProgramLoader (bool rethrow=false)
	Create a ProgramLoader which by default does not throw any exceptions.
Functions	loadFunction (const std::string &s, TaskContext *target, const std::string &filename)
	Executes all not exported functions in target's Processor or loads exported functions in target's Command Interface.
Functions	loadFunction (const std::string &filename, TaskContext *target)
	Executes all not exported functions in target's Processor or loads exported functions in target's Command Interface.
bool	loadProgram (const std::string &s, TaskContext *target, const std::string &filename)
	Load Programs and/or exported Functions from an Orocos Program Script into a TaskContext.
bool	loadProgram (const std::string &filename, TaskContext *target)
	Load Programs and/or exported Functions from an Orocos Program Script into a TaskContext.
bool	unloadProgram (const std::string &name, TaskContext *target)
	Unload a Program from a TaskContext.
bool	loadStateMachine (const std::string &s, TaskContext *target, const std::string &filename)
	Load StateMachines from an Orocos State Description into a TaskContext.
bool	loadStateMachine (const std::string &filename, TaskContext *target)
	Load StateMachines from an Orocos State Description into a TaskContext.
bool	unloadStateMachine (const std::string &name, TaskContext *target)
	Unload a root (parent) StateMachine from a TaskContext.

---

Constructor & Destructor Documentation

ProgramLoader

(

bool

rethrow = false

)

Create a ProgramLoader which by default does not throw any exceptions.

Parameters:

rethrow

If set to true, rethrow the parse and load exceptions in addition to logging the error.

See also:

program_load_exception, program_unload_exception, parse_exception

Definition at line 54 of file ProgramLoader.cpp.

---

Member Function Documentation

ProgramLoader::Functions loadFunction	(	const std::string &	s,
		TaskContext *	target,
		const std::string &	filename
	)

Executes all not exported functions in target's Processor or loads exported functions in target's Command Interface.

Returns:

All functions being executed.

Definition at line 64 of file ProgramLoader.cpp.

References TaskContext::scripting().

ProgramLoader::Functions loadFunction	(	const std::string &	filename,
		TaskContext *	target
	)

Executes all not exported functions in target's Processor or loads exported functions in target's Command Interface.

Returns:

All functions being executed.

Definition at line 59 of file ProgramLoader.cpp.

References TaskContext::scripting().

bool loadProgram	(	const std::string &	s,
		TaskContext *	target,
		const std::string &	filename
	)

Load Programs and/or exported Functions from an Orocos Program Script into a TaskContext.

Reads out the stream s , parses it, and loads it in target's Processor.

Returns:

true if all programs and functions could be loaded.

Definition at line 74 of file ProgramLoader.cpp.

References ScriptingAccess::loadStateMachines(), and TaskContext::scripting().

bool loadProgram	(	const std::string &	filename,
		TaskContext *	target
	)

Load Programs and/or exported Functions from an Orocos Program Script into a TaskContext.

Reads out the local file filename , parses it, and loads it in target's Processor.

Returns:

true if all programs and functions could be loaded.

Definition at line 69 of file ProgramLoader.cpp.

References ScriptingAccess::loadPrograms(), and TaskContext::scripting().

bool unloadProgram	(	const std::string &	name,
		TaskContext *	target
	)

Unload a Program from a TaskContext.

Parameters:

name

the name of the program.

Definition at line 79 of file ProgramLoader.cpp.

References TaskContext::scripting(), and ScriptingAccess::unloadProgram().

bool loadStateMachine	(	const std::string &	s,
		TaskContext *	target,
		const std::string &	filename
	)

Load StateMachines from an Orocos State Description into a TaskContext.

Reads out the stream s , parses it, and loads it in target's Processor.

Returns:

true if all state machines could be loaded.

Definition at line 94 of file ProgramLoader.cpp.

References ScriptingAccess::loadStateMachines(), and TaskContext::scripting().

bool loadStateMachine	(	const std::string &	filename,
		TaskContext *	target
	)

Load StateMachines from an Orocos State Description into a TaskContext.

Reads out the local file filename , parses it, and loads it in target's Processor.

Returns:

true if all state machines could be loaded.

Definition at line 89 of file ProgramLoader.cpp.

References ScriptingAccess::loadStateMachines(), and TaskContext::scripting().

bool unloadStateMachine	(	const std::string &	name,
		TaskContext *	target
	)

Unload a root (parent) StateMachine from a TaskContext.

Parameters:

name

the name of the StateMachine.

Definition at line 84 of file ProgramLoader.cpp.

References TaskContext::scripting(), and ScriptingAccess::unloadStateMachine().

---

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

• rtt/scripting/ProgramLoader.hpp
• rtt/scripting/ProgramLoader.cpp

---