RTT::detail::PeerParser Class Reference

Get the peer and object from an invocation path like a.b.c.d() . More...

#include <rtt/scripting/PeerParser.hpp>

List of all members.

Public Member Functions

 PeerParser (TaskContext *c, CommonParser &cp, bool fullpath=false)
 Create a PeerParser which starts looking for peers from a task.
void reset ()
 After reset, peer() == current context and object() == "this".
rule_t & parser ()
 The parser tries to traverse a full peer-to-object path and throws if it got stuck in the middle.
rule_t & locator ()
 The locator tries to go as far as possible in the peer-to-object path and will never throw.
TaskContextpeer ()
 Returns the last matching peer.
std::string object ()
 Returns the last matching object name.
OperationInterfacetaskObject ()
 Returns the last matching TaskObject or zero if not found.

Detailed Description

Get the peer and object from an invocation path like a.b.c.d() .

Definition at line 59 of file PeerParser.hpp.


Constructor & Destructor Documentation

RTT::detail::PeerParser::PeerParser ( TaskContext c,
CommonParser cp,
bool  fullpath = false 
)

Create a PeerParser which starts looking for peers from a task.

Parameters:
c The task to start searching from.
fullpath Set to true if the parser() must resolve the full path.

Member Function Documentation

rule_t& RTT::detail::PeerParser::locator (  ) 

The locator tries to go as far as possible in the peer-to-object path and will never throw.

peer() and object() will contain the last valid peer found and its supposed object, attribute or value.

rule_t& RTT::detail::PeerParser::parser (  ) 

The parser tries to traverse a full peer-to-object path and throws if it got stuck in the middle.

peer() will return the target peer and object() is this or the supposed object of the peer. The parser does not check if this object exists.


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:22:47 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3