#include <rtt/scripting/ConditionBool.hpp>

Inheritance diagram for RTT::scripting::ConditionBool:

Public Member Functions
	ConditionBool ()
	Construct a new ConditionBool object and set it's value to false. More...

	ConditionBool (bool value)
	Construct a new ConditionBool object with a specified value. More...

virtual	~ConditionBool ()
	Destroy the ConditionBool object. More...

virtual bool	evaluate ()
	Return the boolean value of the ConditionBool object. More...

virtual void	setTrue ()
	Set the value of the ConditionBool object to true. More...

virtual void	setFalse ()
	Set the value of the ConditionBool object to false. More...

virtual ConditionBool *	clone () const
	Return a copy of this Condition... More...

virtual void	reset ()
	Some conditions need to be reset at some points. More...

virtual ConditionInterface *	copy (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...

Detailed Description

Definition at line 52 of file ConditionBool.hpp.

Constructor & Destructor Documentation

RTT::ConditionBool::ConditionBool ( )

Construct a new ConditionBool object and set it's value to false.

Definition at line 42 of file ConditionBool.cpp.

Referenced by clone().

RTT::ConditionBool::ConditionBool ( bool value )

Construct a new ConditionBool object with a specified value.

Parameters

value The value of the ConditionBool object.

Definition at line 47 of file ConditionBool.cpp.

RTT::ConditionBool::~ConditionBool ( )

virtual

Destroy the ConditionBool object.

Definition at line 52 of file ConditionBool.cpp.

Member Function Documentation

ConditionBool * RTT::ConditionBool::clone ( ) const

virtual

Return a copy of this Condition...

Implements RTT::scripting::ConditionInterface.

Definition at line 71 of file ConditionBool.cpp.

References ConditionBool().

ConditionInterface * RTT::ConditionInterface::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > & alreadyCloned ) const

virtualinherited

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 in RTT::scripting::EvalCommandResult, RTT::scripting::ConditionCompositeNOT, RTT::scripting::ConditionBinaryCompositeOR, RTT::scripting::TryCommandResult, RTT::scripting::ConditionCache, RTT::scripting::ConditionDSDuration, RTT::scripting::ConditionCompare< T, compare_op >, RTT::scripting::ConditionInvert, RTT::scripting::ConditionBoolDataSource, and RTT::scripting::ConditionBinaryCompositeAND.

Definition at line 50 of file ConditionInterface.cpp.

Referenced by RTT::scripting::ParsedStateMachine::copy(), RTT::scripting::ConditionBinaryCompositeAND::copy(), RTT::scripting::DataSourceCondition::copy(), and RTT::scripting::ConditionBinaryCompositeOR::copy().

bool RTT::ConditionBool::evaluate ( )

virtual

Return the boolean value of the ConditionBool object.

Implements RTT::scripting::ConditionInterface.

Definition at line 56 of file ConditionBool.cpp.

void RTT::ConditionInterface::reset ( )

virtualinherited

Some conditions need to be reset at some points.

E.g. a scripting::ConditionDuration counts the time since the first time a Command was executed, and if this time exceeds a certain preset time, returns true. Therefore, it needs to be reset, i.e. it needs to start counting, when the command is first executed.. scripting::ConditionOnce has a similar need. This function is called at such times.

Reimplemented in RTT::scripting::ConditionCompositeNOT, RTT::scripting::ConditionBinaryCompositeOR, RTT::scripting::ConditionBinaryCompositeAND, RTT::scripting::ConditionExpire, RTT::scripting::ConditionDSDuration, RTT::scripting::ConditionCache, RTT::scripting::ConditionDuration, RTT::scripting::ConditionBoolDataSource, and RTT::scripting::ConditionOnce.

Definition at line 47 of file ConditionInterface.cpp.

Referenced by RTT::scripting::Parser::parseCondition(), RTT::scripting::DataSourceCondition::reset(), RTT::scripting::ConditionBinaryCompositeAND::reset(), RTT::scripting::EdgeCondition::reset(), and RTT::scripting::ConditionBinaryCompositeOR::reset().

void RTT::ConditionBool::setFalse ( )

virtual

Set the value of the ConditionBool object to false.

Definition at line 66 of file ConditionBool.cpp.

void RTT::ConditionBool::setTrue ( )

virtual

Set the value of the ConditionBool object to true.

Definition at line 61 of file ConditionBool.cpp.

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

rtt/scripting/ConditionBool.hpp
rtt/scripting/ConditionBool.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation