Orocos Real-Time Toolkit  2.9.0
TypeMarshaller.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:08 CEST 2009 TypeMarshaller.hpp
3 
4  TypeMarshaller.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 /*
40  * TypeMarshaller.hpp
41  *
42  * Created on: Sep 17, 2009
43  * Author: kaltan
44  */
45 
46 #ifndef TYPEMARSHALLER_HPP_
47 #define TYPEMARSHALLER_HPP_
48 
49 #include "TypeTransporter.hpp"
50 
51 namespace RTT
52 {
53 
54  namespace types
55  {
56 
62  {
63  public:
68  virtual void* createCookie() const { return 0; }
70  virtual void deleteCookie(void* cookie) const {}
84  virtual std::pair<void const*,int> fillBlob( base::DataSourceBase::shared_ptr source, void* blob, int size, void* cookie = 0) const = 0;
85 
91  virtual bool updateFromBlob(const void* blob, int size, base::DataSourceBase::shared_ptr target, void* cookie = 0) const = 0;
92 
97  virtual unsigned int getSampleSize( base::DataSourceBase::shared_ptr sample, void* cookie = 0) const = 0;
98 
99  };
100 
101  }
102 
103 }
104 
105 #endif /* TYPEMARSHALLER_HPP_ */
virtual bool updateFromBlob(const void *blob, int size, base::DataSourceBase::shared_ptr target, void *cookie=0) const =0
Update target with the contents of blob which is an object of a protocol.
virtual void * createCookie() const
Overload in subclasses for marshallers that need to allocate some internal data.
This interface defines the function a transport protocol must support in order to allow Orocos compon...
Objects implementing this interface have the capability to convert data sources to and from a binary ...
virtual void deleteCookie(void *cookie) const
Called to delete a cookie created with createCookie.
virtual std::pair< void const *, int > fillBlob(base::DataSourceBase::shared_ptr source, void *blob, int size, void *cookie=0) const =0
Create an transportable object for a protocol which contains the value of source. ...
virtual unsigned int getSampleSize(base::DataSourceBase::shared_ptr sample, void *cookie=0) const =0
Returns the size in bytes of a marshalled data element.
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