Orocos Real-Time Toolkit  2.6.0
Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Attributes
RTT::Scripting Class Reference

The method interface of the scripting plugin. More...

#include <rtt/scripting/Scripting.hpp>

Inheritance diagram for RTT::Scripting:
RTT::ServiceRequester

List of all members.

Public Types

typedef
scripting::ProgramInterface::Status 
ProgramStatus
typedef
scripting::StateMachine::Status 
StateMachineStatus
typedef std::vector< std::string > RequesterNames
typedef std::vector< std::string > OperationCallerNames

Public Member Functions

 Scripting (TaskContext *owner)
const std::string & getRequestName () const
RequesterNames getRequesterNames () const
TaskContextgetServiceOwner () const
 The owner is the top-level TaskContext owning this service (indirectly).
Service::shared_ptr getReferencedService ()
 Returns the service we're referencing.
bool addOperationCaller (base::OperationCallerBaseInvoker &mbi)
OperationCallerNames getOperationCallerNames () const
base::OperationCallerBaseInvokergetOperationCaller (const std::string &name)
ServiceRequesterrequires ()
ServiceRequesterrequires (const std::string &service_name)
bool requiresService (const std::string &service_name)
 Query if this service requires certain sub-services.
bool connectTo (Service::shared_ptr sp)
 Connects this service's methods to the operations provided by op.
bool ready () const
 Returns true when all methods were resolved.
void disconnect ()
 Disconnects all methods from their implementation.

Public Attributes

OperationCaller< bool(const
std::string &)> 
unloadProgram
OperationCaller
< ProgramStatus::ProgramStatus(const
std::string &)> 
getProgramStatus
OperationCaller< std::string(const
std::string &)> 
getProgramStatusStr
OperationCaller< std::vector
< std::string >void)> 
getProgramList
OperationCaller< bool(const
std::string &)> 
unloadStateMachine
OperationCaller
< StateMachineStatus::StateMachineStatus(const
std::string &)> 
getStateMachineStatus
OperationCaller< std::string(const
std::string &)> 
getStateMachineStatusStr
OperationCaller< std::vector
< std::string >)> 
getStateMachineList
OperationCaller< int(const
std::string &)> 
execute
OperationCaller< bool(const
std::string &)> 
runScript
OperationCaller< bool(const
std::string &)> 
eval
OperationCaller< bool(const
std::string &)> 
loadPrograms
OperationCaller< bool(const
std::string &)> 
loadProgramText
OperationCaller< int(const
std::string &)> 
getProgramLine
OperationCaller< std::string(const
std::string &)> 
getProgramText
OperationCaller< bool(const
std::string &)> 
loadStateMachines
OperationCaller< bool(const
std::string &code)> 
loadStateMachineText
OperationCaller< std::string(const
std::string &)> 
getStateMachineText
OperationCaller< int(const
std::string &)> 
getStateMachineLine
OperationCaller< bool(const
std::string &)> 
startProgram
OperationCaller< bool(const
std::string &)> 
stopProgram
OperationCaller< bool(const
std::string &)> 
pauseProgram
OperationCaller< bool(const
std::string &)> 
stepProgram
OperationCaller< bool(const
std::string &)> 
hasProgram
OperationCaller< bool(const
std::string &)> 
isProgramRunning
OperationCaller< bool(const
std::string &)> 
isProgramPaused
OperationCaller< bool(const
std::string &)> 
inProgramError
OperationCaller< bool(const
std::string &)> 
activateStateMachine
OperationCaller< bool(const
std::string &)> 
deactivateStateMachine
OperationCaller< bool(const
std::string &)> 
startStateMachine
OperationCaller< bool(const
std::string &)> 
pauseStateMachine
OperationCaller< bool(const
std::string &)> 
stopStateMachine
OperationCaller< bool(const
std::string &)> 
resetStateMachine
OperationCaller< bool(const
std::string &, const
std::string &)> 
requestStateMachineState
OperationCaller< bool(const
std::string &)> 
hasStateMachine
OperationCaller< bool(const
std::string &)> 
isStateMachineActive
OperationCaller< bool(const
std::string &)> 
isStateMachineRunning
OperationCaller< bool(const
std::string &)> 
inStateMachineError
OperationCaller< bool(const
std::string &)> 
isStateMachinePaused
OperationCaller< std::string(const
std::string &)> 
getStateMachineState
OperationCaller< bool(const
std::string &, const
std::string &)> 
inStateMachineState

Protected Types

typedef std::map< std::string,
ServiceRequester * > 
Requests
typedef std::map< std::string,
base::OperationCallerBaseInvoker * > 
OperationCallers
 Our methods.

Protected Attributes

Requests mrequests
 the services we implement.
OperationCallers mmethods
std::string mrname
TaskContextmrowner
Service::shared_ptr mprovider

Detailed Description

The method interface of the scripting plugin.

Definition at line 54 of file Scripting.hpp.


Member Function Documentation

bool RTT::ServiceRequester::connectTo ( Service::shared_ptr  sp) [inherited]

Connects this service's methods to the operations provided by op.

This method tries to match as many as possible method-operation pairs.

You may call this function with different instances of sp to 'resolve' missing functions, only the non-connected methods will be further filled in.

Parameters:
spAn interface-compatible Service.
Returns:
true if all methods of that are required are provided, false if not all methods could yet be matched.

Definition at line 92 of file ServiceRequester.cpp.

References RTT::base::TaskCore::engine(), and RTT::ServiceRequester::ready().

Referenced by RTT::TaskContext::connectServices().

Service::shared_ptr RTT::ServiceRequester::getReferencedService ( ) [inherited]

Returns the service we're referencing.

In case you used connectTo to more than one service, this returns the service which was used when connectTo first returned true.

bool RTT::ServiceRequester::ready ( ) const [inherited]

Returns true when all methods were resolved.

Returns:

Definition at line 132 of file ServiceRequester.cpp.

Referenced by RTT::TaskContext::connectServices(), and RTT::ServiceRequester::connectTo().

bool RTT::ServiceRequester::requiresService ( const std::string &  service_name) [inline, inherited]

Query if this service requires certain sub-services.

Parameters:
service_name
Returns:

Definition at line 112 of file ServiceRequester.hpp.


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