Public Types | Public Member Functions | Private Attributes
RTT::scripting::Parser Class Reference

This class is the public interface to the Orocos Program Parser Framework. It parsers Orocos program scripts, Orocos State Contexts and allows to parse a text Command, Condition or Expression to the respective objects. More...

#include <Parser.hpp>

List of all members.

Public Types

typedef std::vector
< ProgramInterfacePtr
ParsedFunctions
typedef std::vector
< ProgramInterfacePtr
ParsedPrograms
typedef std::vector
< ParsedStateMachinePtr
ParsedStateMachines

Public Member Functions

ConditionInterfaceparseCondition (const std::string &s, TaskContext *)
 Parses the string as a condition, and returns a new ConditionInterface. Will throw parse_exception on failure. Use ext to get the data from the components.
base::DataSourceBase::shared_ptr parseExpression (const std::string &s, TaskContext *)
 Parses the expression in s.
ParsedFunctions parseFunction (const std::string &s, TaskContext *, const std::string &filename="stream")
 Reads out the string, parses it, and returns a new FunctionGraph.
ParsedPrograms parseProgram (const std::string &s, TaskContext *, const std::string &filename="stream")
 Reads out the string, parses it, and returns a new ProgramGraph.
 Parser (ExecutionEngine *caller=0)
ParsedStateMachines parseStateMachine (const std::string &s, TaskContext *, const std::string &filename="stream")
 Reads out the string, parses it, and returns a new ParsedStateMachine.
base::DataSourceBase::shared_ptr parseValueChange (const std::string &s, TaskContext *)
 Parses a change of a value in s.
base::DataSourceBase::shared_ptr parseValueStatement (const std::string &s, TaskContext *)
 Parses a whole value manipulation/creation statement. Requires the set/var/const etc prefixes.
void runScript (std::string const &code, TaskContext *mowner, ScriptingService *service, std::string const &filename)

Private Attributes

ExecutionEnginemcaller

Detailed Description

This class is the public interface to the Orocos Program Parser Framework. It parsers Orocos program scripts, Orocos State Contexts and allows to parse a text Command, Condition or Expression to the respective objects.

See also:
ScriptingAccess for a more user friendly loading of scripts into TaskContexts.

Definition at line 65 of file Parser.hpp.


Member Typedef Documentation

List of parsed functions.

Definition at line 89 of file Parser.hpp.

List of parsed programs.

Definition at line 101 of file Parser.hpp.

List of parsed State Machines.

Definition at line 113 of file Parser.hpp.


Constructor & Destructor Documentation

Create a parser and allow to explicitly specify which TaskContext's ExecutionEngine is calling it. This allows to generate the correct asynchonous method invocation code in case caller and parser are not identical.

Definition at line 54 of file Parser.cpp.


Member Function Documentation

ConditionInterface * RTT::Parser::parseCondition ( const std::string &  s,
TaskContext tc 
)

Parses the string as a condition, and returns a new ConditionInterface. Will throw parse_exception on failure. Use ext to get the data from the components.

Exceptions:
parse_exception

Definition at line 131 of file Parser.cpp.

Parses the expression in s.

Returns:
A base::DataSourceBase which contains the expression.
Exceptions:
parse_exceptionThrows exceptions of type parse_exception.

Definition at line 160 of file Parser.cpp.

Parser::ParsedFunctions RTT::Parser::parseFunction ( const std::string &  s,
TaskContext c,
const std::string &  filename = "stream" 
)

Reads out the string, parses it, and returns a new FunctionGraph.

Exceptions:
parse_exceptionThrows exceptions of type parse_exception.

Definition at line 81 of file Parser.cpp.

Parser::ParsedPrograms RTT::Parser::parseProgram ( const std::string &  s,
TaskContext c,
const std::string &  filename = "stream" 
)

Reads out the string, parses it, and returns a new ProgramGraph.

Exceptions:
parse_exceptionThrows exceptions of type parse_exception.

Definition at line 93 of file Parser.cpp.

Parser::ParsedStateMachines RTT::Parser::parseStateMachine ( const std::string &  s,
TaskContext c,
const std::string &  filename = "stream" 
)

Reads out the string, parses it, and returns a new ParsedStateMachine.

Exceptions:
file_parse_exceptionThrows exceptions of type file_parse_exception.

Definition at line 107 of file Parser.cpp.

Parses a change of a value in s.

Returns:
A base::DataSourceBase which contains the command to change the value.
Exceptions:
parse_exceptionThrows exceptions of type parse_exception.

Definition at line 191 of file Parser.cpp.

Parses a whole value manipulation/creation statement. Requires the set/var/const etc prefixes.

Returns:
A base::DataSourceBase which contains the command to change the value.
Exceptions:
parse_exceptionThrows exceptions of type parse_exception.

Definition at line 197 of file Parser.cpp.

void RTT::Parser::runScript ( std::string const &  code,
TaskContext mowner,
ScriptingService service,
std::string const &  filename 
)

Runs all statements in code.

Parameters:
codeA list of scripting statements and definitions
mownerThe task in which the code must be interpreted
filenameAn informational description of the source of code.
Exceptions:
parse_exceptionand its derivatives.

Definition at line 62 of file Parser.cpp.


Member Data Documentation

Definition at line 67 of file Parser.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:16:25