RTT::detail::RemoteMethodImpl< MethodT > Class Template Reference

A Method which executes a remote function directly. More...

#include <rtt/RemoteMethod.hpp>

Inheritance diagram for RTT::detail::RemoteMethodImpl< MethodT >:
RTT::detail::MethodBase< MethodT > RTT::detail::DataSourceStorage< MethodT > RTT::ActionInterface

List of all members.

Public Types

typedef boost::function_traits
< MethodT >::result_type 
result_type
typedef boost::shared_ptr
< ActionInterface
shared_ptr
 Use this type for shared pointer storage of an ActionInterface object.

Public Member Functions

 RemoteMethodImpl ()
 The defaults are reset by the constructor.
result_type invoke ()
 Call this operator if the RemoteMethod takes no arguments.
template<class T1 >
result_type invoke (T1 a1)
template<class T1 , class T2 >
result_type invoke (T1 a1, T2 a2)
template<class T1 , class T2 , class T3 >
result_type invoke (T1 a1, T2 a2, T3 a3)
template<class T1 , class T2 , class T3 , class T4 >
result_type invoke (T1 a1, T2 a2, T3 a3, T4 a4)
virtual MethodBase< MethodT > * cloneI () const =0
virtual bool execute ()=0
 Execute the functionality of this action.
virtual void reset ()
 Reset this action.
virtual bool valid () const
 Inspect if this action was executed and valid.
virtual void readArguments ()=0
 This is invoked some time before execute() at a time when the action may read its function arguments.
virtual ActionInterfaceclone () const =0
 The Clone Software Pattern.
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
 When copying an Orocos program, we want identical DataSource's to be mapped to identical DataSources, in order for the program to work correctly.

Protected Attributes

MethodC mmeth

Detailed Description

template<class MethodT>
class RTT::detail::RemoteMethodImpl< MethodT >

A Method which executes a remote function directly.

Parameters:
MethodT The function signature of the method. For example, bool( int, Frame, double)

Definition at line 60 of file RemoteMethod.hpp.


Member Function Documentation

virtual ActionInterface* RTT::ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > &  alreadyCloned  )  const [virtual, inherited]

When copying an Orocos program, we want identical DataSource's to be mapped to identical DataSources, in order for the program to work correctly.

This is different from the clone function, where we simply want a new Action that can replace the old one directly.

This function takes a map that maps the old DataSource's onto their new replacements. This way, it is possible to check before cloning a DataSource, whether it has already been copied, and if so, reuse the existing copy.

To keep old source working, the standard implementation of this function simply calls the clone function. If your ActionInterface uses a DataSource, it is important that you reimplement this function correctly though.

Reimplemented in RTT::detail::DataSourceArgsEvent< SignatureT, FunctorT >, and RTT::DispatchAction.

virtual bool RTT::ActionInterface::execute (  )  [pure virtual, inherited]

Execute the functionality of this action.

Returns:
true if the action was accepted, false otherwise

Implemented in RTT::detail::DataSourceArgsEvent< SignatureT, FunctorT >, RTT::DispatchAction, and RTT::detail::EventBase< Signature >.

template<class MethodT >
result_type RTT::detail::RemoteMethodImpl< MethodT >::invoke (  )  [inline]

Call this operator if the RemoteMethod takes no arguments.

Returns:
true if ready and succesfully sent.

Definition at line 81 of file RemoteMethod.hpp.

References RTT::MethodC::execute().

virtual void RTT::ActionInterface::reset (  )  [virtual, inherited]

Reset this action.

Must be used after execute() failed.

Reimplemented in RTT::DispatchAction.

virtual bool RTT::ActionInterface::valid (  )  const [virtual, inherited]

Inspect if this action was executed and valid.

This method may not be called before execute(). The default implementation returns always true, i.e. after execute(), it was executed. Override this method if it has more complex state semantics.

Reimplemented in RTT::DispatchAction.


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