Orocos Real-Time Toolkit  2.8.3
ConditionExpire.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 10 16:16:57 CEST 2002 ConditionExpire.hpp
3 
4  ConditionExpire.hpp - description
5  -------------------
6  begin : Thu October 10 2002
7  copyright : (C) 2002 Peter Soetens
8  email : peter.soetens@mech.kuleuven.ac.be
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 CONDITIONEXPIRE_HPP
40 #define CONDITIONEXPIRE_HPP
41 
42 #include "ConditionInterface.hpp"
43 #include "../os/TimeService.hpp"
44 
45 namespace RTT
46 { namespace scripting {
47 
55  : public ConditionInterface
56  {
57  typedef os::TimeService::ticks ticks;
58 
59  public:
65  ConditionExpire( ticks t )
66  : time( t ), hb( os::TimeService::Instance() )
67  {
68  timestamp = hb->getTicks();
69  }
70 
71  virtual ~ConditionExpire()
72  {}
73 
74  virtual bool evaluate()
75  {
76  return ( time > hb->ticksSince(timestamp) );
77  }
78 
79  virtual void reset()
80  {
81  timestamp = hb->getTicks();
82  }
83 
84  virtual ConditionInterface* clone() const
85  {
86  return new ConditionExpire( time );
87  }
88 
89  private:
93  ticks time;
94  ticks timestamp;
98  os::TimeService *hb;
99  };
100 
101 }}
102 
103 #endif
The TimeService is used for system-wide time keeping and conversions.
Definition: TimeService.hpp:35
long long ticks
The type for the systems clock tick.
Definition: TimeService.hpp:66
This interface represents the concept of a condition which can be evaluated and return true or false...
ConditionExpire(ticks t)
Create a Condition that evaluates to false when t is reached.
#define RTT_SCRIPTING_API
virtual ConditionInterface * clone() const
The Clone Software Pattern.
A conditional that evaluates true until a certain time has elapsed since construction or the last res...
virtual void reset()
Some conditions need to be reset at some points.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:51
virtual bool evaluate()
Evaluate the Condition and return the outcome.