Orocos Real-Time Toolkit  2.9.0
ConnPolicyType.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: The SourceWorks Tue Sep 7 00:55:18 CEST 2010 ConnPolicyType.hpp
3 
4  ConnPolicyType.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 ORO_CONNPOLICYTYPE_HPP_
40 #define ORO_CONNPOLICYTYPE_HPP_
41 
42 #include <boost/serialization/serialization.hpp>
43 #include "../ConnPolicy.hpp"
44 
45 namespace boost {
46  namespace serialization {
52  template<class Archive>
53  void serialize(Archive& a, RTT::ConnPolicy& c, unsigned int) {
54  a & boost::serialization::make_nvp("type", c.type);
55  a & boost::serialization::make_nvp("size", c.size );
56  a & boost::serialization::make_nvp("lock_policy", c.lock_policy );
57  a & boost::serialization::make_nvp("init", c.init );
58  a & boost::serialization::make_nvp("pull", c.pull );
59  a & boost::serialization::make_nvp("buffer_policy", c.buffer_policy );
60  a & boost::serialization::make_nvp("mandatory", c.mandatory );
61  a & boost::serialization::make_nvp("transport", c.transport );
62  a & boost::serialization::make_nvp("data_size", c.data_size );
63  a & boost::serialization::make_nvp("name_id", c.name_id );
64  }
65  }
66 }
67 
68 
69 #endif /* ORO_CONNPOLICYTYPE_HPP_ */
int data_size
Suggest the payload size of the data sent over this channel.
Definition: ConnPolicy.hpp:248
int lock_policy
This is the locking policy on the connection.
Definition: ConnPolicy.hpp:196
int type
DATA, BUFFER or CIRCULAR_BUFFER.
Definition: ConnPolicy.hpp:190
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
int size
If the connection is a buffered connection, the size of the buffer.
Definition: ConnPolicy.hpp:193
bool pull
If true, then the sink will have to pull data.
Definition: ConnPolicy.hpp:209
bool mandatory
Whether the connection described by this connection policy is mandatory, which means that write opera...
Definition: ConnPolicy.hpp:232
bool init
If true, one should initialize the connection&#39;s value with the last value written on the writer port...
Definition: ConnPolicy.hpp:203
int transport
The prefered transport used.
Definition: ConnPolicy.hpp:238
void serialize(Archive &a, RTT::ConnPolicy &c, unsigned int)
Serializes RTT::ConnPolicy objects.
int buffer_policy
The policy on how buffer elements will be installed for this connection, which influences the behavio...
Definition: ConnPolicy.hpp:216
std::string name_id
The name of this connection.
Definition: ConnPolicy.hpp:256