File: pack.h

package info (click to toggle)
esys-particle 2.3.4%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 13,036 kB
  • ctags: 10,805
  • sloc: cpp: 80,009; python: 5,872; makefile: 1,243; sh: 313; perl: 225
file content (48 lines) | stat: -rw-r--r-- 1,769 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/////////////////////////////////////////////////////////////
//                                                         //
// Copyright (c) 2003-2014 by The University of Queensland //
// Centre for Geoscience Computing                         //
// http://earth.uq.edu.au/centre-geoscience-computing      //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.apache.org/licenses/LICENSE-2.0          //
//                                                         //
/////////////////////////////////////////////////////////////

#ifndef _PACK_H
#define _PACK_H

//--- project includes ---
#include "tml/message/packed_message_interface.h"


/*! \file pack.h */

/*!
\fn TML_pack(TML_Packed_Message*,const T&);
\brief templated function to pack objects into a TML_Packed_Message

Implemented as separate template function and not as member function of the object
to be packed for the following reasons: 
a) it forces redefinition in each derived class, even if there is a packing function for the base class
b) it makes packing for builtin types consistent

*/
template<typename T>
void TML_pack(TML_PackedMessageInterface*,const T&);

/*!
\fn TML_unpack(TML_Packed_Message*,T&);
\brief templated function to unpack objects from a TML_Packed_Message

Implemented as separate template function and not as member function of the object
to be packed for the following reasons: 
a) it forces redefinition in each derived class, even if there is a packing function for the base class
b) it makes packing for builtin types consistent

*/
template<typename T>
void TML_unpack(TML_PackedMessageInterface*,T&);

#endif //_PACK_H