Orocos Real-Time Toolkit  2.9.0
OutputPortInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 OutputPortInterface.hpp
3 
4  OutputPortInterface.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Sylvain Joyeux
8  email : sylvain.joyeux@m4x.org
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_OUTPUT_PORT_INTERFACE_HPP
40 #define ORO_OUTPUT_PORT_INTERFACE_HPP
41 
42 #include "PortInterface.hpp"
43 #include "DataSourceBase.hpp"
44 
45 namespace RTT
46 { namespace base {
47 
53  {
54  protected:
58  virtual bool connectionAdded(ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy) = 0;
59 
61  public:
67  virtual bool addConnection(internal::ConnID* port_id, ChannelElementBase::shared_ptr channel_input, ConnPolicy const& policy);
68 
69  OutputPortInterface(std::string const& name);
70 
71  virtual ~OutputPortInterface();
72 
76  virtual bool keepsLastWrittenValue() const = 0;
77 
86  virtual void keepLastWrittenValue(bool new_flag) = 0;
87 
92  virtual DataSourceBase::shared_ptr getDataSource() const = 0;
93 
94  virtual void disconnect();
95 
99  virtual bool connected() const;
100 
104  virtual WriteStatus write(DataSourceBase::shared_ptr source);
105 
109  bool createDataConnection( InputPortInterface& sink, int lock_policy = ConnPolicy::LOCK_FREE );
110 
115  bool createBufferConnection( InputPortInterface& sink, int size, int lock_policy = ConnPolicy::LOCK_FREE );
116 
118 
122  bool createConnection( InputPortInterface& sink );
123 
127  virtual bool createConnection( InputPortInterface& sink, ConnPolicy const& policy ) = 0;
128 
132  virtual bool createConnection( internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const& policy = ConnPolicy() );
133 
135  virtual bool disconnect(PortInterface* port);
136 
137  virtual bool connectTo(PortInterface* other, ConnPolicy const& policy);
138 
139  virtual bool connectTo(PortInterface* other);
140  };
141 }}
142 
143 #endif
The base class of the InputPort.
boost::intrusive_ptr< SharedConnectionBase > shared_ptr
#define RTT_API
Definition: rtt-config.h:97
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
virtual bool createConnection(internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const &policy=ConnPolicy())=0
Connects this port to an existing shared connection instance.
The base class of each OutputPort.
static const int LOCK_FREE
Definition: ConnPolicy.hpp:117
boost::intrusive_ptr< ChannelElementBase > shared_ptr
This class is used in places where a permanent representation of a reference to a connection is neede...
Definition: ConnID.hpp:58
boost::intrusive_ptr< DataSourceBase > shared_ptr
Use this type to store a pointer to a DataSourceBase.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
The base class of every data flow port.
WriteStatus
Returns the status of a data flow write operation.
Definition: FlowStatus.hpp:66