Orocos Real-Time Toolkit  2.8.3
Public Types | Public Member Functions | List of all members
RTT::internal::AssignCommand< T, S > Class Template Reference

This is a command that will assign the value of an expression to another at runtime. More...

#include <rtt/internal/AssignCommand.hpp>

Inheritance diagram for RTT::internal::AssignCommand< T, S >:
RTT::base::ActionInterface

Public Types

typedef AssignableDataSource< T >::shared_ptr LHSSource
 
typedef DataSource< S >::const_ptr RHSSource
 
typedef boost::shared_ptr< ActionInterfaceshared_ptr
 Use this type for shared pointer storage of an ActionInterface object. More...
 

Public Member Functions

 AssignCommand (LHSSource l, RHSSource r)
 Assign r (rvalue) to l (lvalue);. More...
 
void readArguments ()
 This is invoked some time before execute() at a time when the action may read its function arguments. More...
 
bool execute ()
 Execute the functionality of this action. More...
 
virtual base::ActionInterfaceclone () const
 The Clone Software Pattern. More...
 
virtual base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More...
 
virtual void reset ()
 Reset this action. More...
 
virtual bool valid () const
 Inspect if this action was executed and valid. More...
 

Detailed Description

template<typename T, typename S = T>
class RTT::internal::AssignCommand< T, S >

This is a command that will assign the value of an expression to another at runtime.

You pass it the AssignableDataSource that you want to assign to, and the DataSource that you want to assign on construction, and it will take care of the assignment. Note that both DataSource's need to be of a convertible type, and this class needs that type as its template parameter..

Parameters
TTarget type
SSource type

Definition at line 60 of file AssignCommand.hpp.

Member Typedef Documentation

template<typename T, typename S = T>
typedef AssignableDataSource<T>::shared_ptr RTT::internal::AssignCommand< T, S >::LHSSource

Definition at line 64 of file AssignCommand.hpp.

template<typename T, typename S = T>
typedef DataSource<S>::const_ptr RTT::internal::AssignCommand< T, S >::RHSSource

Definition at line 65 of file AssignCommand.hpp.

typedef boost::shared_ptr<ActionInterface> RTT::base::ActionInterface::shared_ptr
inherited

Use this type for shared pointer storage of an ActionInterface object.

Definition at line 78 of file ActionInterface.hpp.

Constructor & Destructor Documentation

template<typename T, typename S = T>
RTT::internal::AssignCommand< T, S >::AssignCommand ( LHSSource  l,
RHSSource  r 
)
inline

Assign r (rvalue) to l (lvalue);.

Definition at line 74 of file AssignCommand.hpp.

Referenced by RTT::internal::AssignCommand< T, S >::clone(), and RTT::internal::AssignCommand< T, S >::copy().

Member Function Documentation

template<typename T, typename S = T>
virtual base::ActionInterface* RTT::internal::AssignCommand< T, S >::clone ( ) const
inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 93 of file AssignCommand.hpp.

References RTT::internal::AssignCommand< T, S >::AssignCommand().

template<typename T, typename S = T>
virtual base::ActionInterface* RTT::internal::AssignCommand< T, S >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned) const
inlinevirtual

When copying an Orocos program, we want identical internal::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 internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::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 internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::base::ActionInterface.

Definition at line 98 of file AssignCommand.hpp.

References RTT::internal::AssignCommand< T, S >::AssignCommand().

template<typename T, typename S = T>
bool RTT::internal::AssignCommand< T, S >::execute ( )
inlinevirtual

Execute the functionality of this action.

Returns
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 83 of file AssignCommand.hpp.

template<typename T, typename S = T>
void RTT::internal::AssignCommand< T, S >::readArguments ( )
inlinevirtual

This is invoked some time before execute() at a time when the action may read its function arguments.

Implements RTT::base::ActionInterface.

Definition at line 79 of file AssignCommand.hpp.

void ActionInterface::reset ( )
virtualinherited
bool ActionInterface::valid ( ) const
virtualinherited

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::scripting::CallFunction, RTT::scripting::CommandComposite, RTT::scripting::TryCommand, and RTT::scripting::CommandBinary.

Definition at line 53 of file ActionInterface.cpp.

Referenced by RTT::scripting::VertexNode::isValid(), RTT::scripting::CommandBinary::valid(), and RTT::scripting::TryCommand::valid().


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