Orocos Real-Time Toolkit  2.9.0
InputPortSource.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:08 CEST 2009 InputPortSource.hpp
3 
4  InputPortSource.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Peter Soetens
8  email : peter@thesourcworks.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 ORO_INPUT_PORT_SOURCE_HPP
40 #define ORO_INPUT_PORT_SOURCE_HPP
41 
42 #include "Channels.hpp"
43 #include "../base/PortInterface.hpp"
44 
45 namespace RTT
46 { namespace internal {
47 
66  template<typename T>
68  {
69  InputPort<T>* port;
70  mutable T mvalue;
71 
72  public:
73  typedef typename boost::intrusive_ptr<InputPortSource<T> > shared_ptr;
74 
76  : port(&port), mvalue() {
77  port.getDataSample( mvalue );
78  }
79 
80  void reset() { port->clear(); }
81  bool evaluate() const
82  {
83  return port->read(mvalue, false) == NewData;
84  }
85 
86  typename DataSource<T>::result_t value() const
87  { return mvalue; }
89  { return mvalue; }
90  typename DataSource<T>::result_t get() const
91  {
92  if ( evaluate() )
93  return value();
94  else
95  return T();
96  }
97  virtual void set( typename AssignableDataSource<T>::param_t t ) {
98  mvalue = t;
99  }
100 
101  virtual typename AssignableDataSource<T>::reference_t set() {
102  return mvalue;
103  }
104 
106  { return new InputPortSource<T>(*port); }
107  AssignableDataSource<T>* copy( std::map<const base::DataSourceBase*, base::DataSourceBase*>& alreadyCloned ) const
108  { return const_cast<InputPortSource<T>*>(this); }
109  };
110 }}
111 
112 #endif
113 
boost::call_traits< value_t >::reference reference_t
Definition: DataSource.hpp:193
AssignableDataSource< T > * clone() const
Return a shallow clone of this DataSource.
void reset()
Reset the data to initial values.
DataSource< T >::const_reference_t rvalue() const
Get a const reference to the value of this DataSource.
A component&#39;s data input port.
Definition: InputPort.hpp:63
FlowStatus read(base::DataSourceBase::shared_ptr source)
Definition: InputPort.hpp:97
boost::intrusive_ptr< InputPortSource< T > > shared_ptr
bool evaluate() const
Force an evaluation of the DataSourceBase.
DataSource< T >::result_t value() const
Return the result of the last evaluate() function.
AssignableDataSource< T > * copy(std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
Create a deep copy of this internal::DataSource, unless it is already cloned.
This class represents a read port using the data source interface.
InputPortSource(InputPort< T > &port)
A DataSource which has set() methods.
Definition: DataSource.hpp:184
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
details::GetConstRef< T >::type const_reference_t
Definition: DataSource.hpp:107
void clear()
Clears the input buffer (or all input buffers), so that read() will return NoData before a new sample...
Definition: InputPort.hpp:91
void getDataSample(T &sample)
Get a sample of the data on this port, without actually reading the port&#39;s data.
Definition: InputPort.hpp:174
boost::call_traits< value_t >::param_type param_t
Definition: DataSource.hpp:192