Orocos Real-Time Toolkit  2.9.0
ConditionCache.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: The SourceWorks Tue Sep 7 00:55:18 CEST 2010 ConditionCache.hpp
3 
4  ConditionCache.hpp - description
5  -------------------
6  begin : Tue September 07 2010
7  copyright : (C) 2010 The SourceWorks
8  email : peter@thesourceworks.com
9 
10  ***************************************************************************
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU General Public *
13  * License as published by the Free Software Foundation; *
14  * version 2 of the License. *
15  * *
16  * As a special exception, you may use this file as part of a free *
17  * software library without restriction. Specifically, if other files *
18  * instantiate templates or use macros or inline functions from this *
19  * file, or you compile this file and link it with other files to *
20  * produce an executable, this file does not by itself cause the *
21  * resulting executable to be covered by the GNU General Public *
22  * License. This exception does not however invalidate any other *
23  * reasons why the executable file might be covered by the GNU General *
24  * Public License. *
25  * *
26  * This library is distributed in the hope that it will be useful, *
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
29  * Lesser General Public License for more details. *
30  * *
31  * You should have received a copy of the GNU General Public *
32  * License along with this library; if not, write to the Free Software *
33  * Foundation, Inc., 59 Temple Place, *
34  * Suite 330, Boston, MA 02111-1307 USA *
35  * *
36  ***************************************************************************/
37 
38 
39 #ifndef CONDITION_CACHE_HPP
40 #define CONDITION_CACHE_HPP
41 
42 #include "ConditionInterface.hpp"
43 #include "../internal/DataSources.hpp"
44 
45 namespace RTT
46 { namespace scripting {
47 
48 
55  : public ConditionInterface
56  {
57  boost::shared_ptr<ConditionInterface> mc;
59  public:
61  : mc(c), result( ds ? ds : new internal::ValueDataSource<bool>(false) )
62  {
63  }
64 
65  virtual ~ConditionCache()
66  {
67  }
68 
69  virtual bool evaluate()
70  {
71  result->set( mc->evaluate() );
72  return result->value();
73  }
74 
75  virtual void reset() {
76  result->set( false );
77  }
78 
80 
81  virtual ConditionInterface* copy( std::map<const base::DataSourceBase*, base::DataSourceBase*>& alreadyCloned ) const
82  {
83  return new ConditionCache( mc->copy(alreadyCloned), result->copy(alreadyCloned) );
84  }
85 
89  virtual ConditionInterface* clone() const
90  {
91  return new ConditionCache( mc->clone(), result );
92  }
93  };
94 }}
95 
96 #endif
A conditional that evaluates and caches another Condition.
This interface represents the concept of a condition which can be evaluated and return true or false...
virtual void set(param_t t)=0
Set this DataSource with a value.
virtual bool evaluate()
Evaluate the Condition and return the outcome.
#define RTT_SCRIPTING_API
ConditionCache(ConditionInterface *c, internal::AssignableDataSource< bool >::shared_ptr ds=internal::AssignableDataSource< bool >::shared_ptr())
virtual void reset()
Some conditions need to be reset at some points.
virtual ConditionInterface * copy(std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
When copying an Orocos program, we want identical internal::DataSource&#39;s to be mapped to identical Da...
boost::intrusive_ptr< DataSource< T > > shared_ptr
Definition: DataSource.hpp:115
boost::intrusive_ptr< AssignableDataSource< T > > shared_ptr
Use this type to store a pointer to an AssignableDataSource.
Definition: DataSource.hpp:198
internal::DataSource< bool >::shared_ptr getResult()
virtual result_t value() const =0
Return the result of the last evaluate() function.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
A simple, yet very useful DataSource, which keeps a value, and returns it in its get() method...
Definition: DataSources.hpp:60
virtual ConditionInterface * clone() const
A clone will cache the same condition.
virtual AssignableDataSource< T > * copy(std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const =0
Create a deep copy of this internal::DataSource, unless it is already cloned.