RTT::scripting::ConditionCompare< T, compare_op > Class Template Reference

#include <ConditionCompare.hpp>

Inheritance diagram for RTT::scripting::ConditionCompare< T, compare_op >:

[legend]

List of all members.

Public Member Functions
virtual ConditionInterface *	clone () const
	ConditionCompare (internal::DataSource< T > *data1, internal::DataSource< T > *data2)
ConditionCompare *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool	evaluate ()
	Evaluate the Condition and return the outcome.
virtual	~ConditionCompare ()
Private Attributes
internal::DataSource< T > ::shared_ptr	mdata1
internal::DataSource< T > ::shared_ptr	mdata2

---

Detailed Description

template<typename T, typename compare_op>
class RTT::scripting::ConditionCompare< T, compare_op >

A general compare condition. This compares two variables of type T, which it gets from two internal::DataSource<T>, using the compare_op given. You should use std::less, std::less_equal, std::greater, std::greater_equal, std::equal_to and std::not_equal_to or other binary predicate functors as compare_op.

Definition at line 57 of file ConditionCompare.hpp.

---

Constructor & Destructor Documentation

template<typename T , typename compare_op >

RTT::scripting::ConditionCompare< T, compare_op >::ConditionCompare	(	internal::DataSource< T > *	data1,
		internal::DataSource< T > *	data2
	)			[inline]

Definition at line 63 of file ConditionCompare.hpp.

template<typename T , typename compare_op >

virtual RTT::scripting::ConditionCompare< T, compare_op >::~ConditionCompare

(

)

[inline, virtual]

Definition at line 76 of file ConditionCompare.hpp.

---

Member Function Documentation

template<typename T , typename compare_op >

virtual ConditionInterface* RTT::scripting::ConditionCompare< T, compare_op >::clone

(

)

const [inline, virtual]

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 67 of file ConditionCompare.hpp.

template<typename T , typename compare_op >

ConditionCompare* RTT::scripting::ConditionCompare< T, compare_op >::copy

(

std::map< const base::DataSourceBase *, base::DataSourceBase * > &

alreadyCloned

)

const [inline, virtual]

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 Command 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 ConditionInterface uses a internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::scripting::ConditionInterface.

Definition at line 72 of file ConditionCompare.hpp.

template<typename T , typename compare_op >

bool RTT::scripting::ConditionCompare< T, compare_op >::evaluate

(

)

[inline, virtual]

Evaluate the Condition and return the outcome.

Returns:

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 79 of file ConditionCompare.hpp.

---

Member Data Documentation

template<typename T , typename compare_op >

internal::DataSource<T>::shared_ptr RTT::scripting::ConditionCompare< T, compare_op >::mdata1 [private]

Definition at line 60 of file ConditionCompare.hpp.

template<typename T , typename compare_op >

internal::DataSource<T>::shared_ptr RTT::scripting::ConditionCompare< T, compare_op >::mdata2 [private]

Definition at line 61 of file ConditionCompare.hpp.

---

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

• ConditionCompare.hpp