1 // Marshaller.h
2 
3 // -*- mode: c++; c-basic-offset:4 -*-
4 
5 // This file is part of libdap, A C++ implementation of the OPeNDAP Data
6 // Access Protocol.
7 
8 // Copyright (c) 2002,2003 OPeNDAP, Inc.
9 // Author: Patrick West <pwest@ucar.edu>
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License along with this library; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
24 //
25 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
26 
27 // (c) COPYRIGHT URI/MIT 1994-1999
28 // Please read the full copyright statement in the file COPYRIGHT_URI.
29 //
30 // Authors:
31 //      pwest       Patrick West <pwest@ucar.edu>
32 
33 #ifndef A_Marshaller_h
34 #define A_Marshaller_h 1
35 
36 #include <string>
37 #include <vector>
38 
39 #include "DapObj.h"
40 #include "Type.h"
41 #include "dods-datatypes.h"
42 #include "InternalErr.h"
43 
44 namespace libdap {
45 
46 class Vector;
47 
48 /** @brief abstract base class used to marshal/serialize dap data objects
49  */
50 class Marshaller: public DapObj {
51 public:
52     virtual void put_byte(dods_byte val) = 0;
53 
54     virtual void put_int16(dods_int16 val) = 0;
55     virtual void put_int32(dods_int32 val) = 0;
56 
57     virtual void put_float32(dods_float32 val) = 0;
58     virtual void put_float64(dods_float64 val) = 0;
59 
60     virtual void put_uint16(dods_uint16 val) = 0;
61     virtual void put_uint32(dods_uint32 val) = 0;
62 
63     virtual void put_str(const std::string &val) = 0;
64     virtual void put_url(const std::string &val) = 0;
65 
66     virtual void put_opaque(char *val, unsigned int len) = 0;
67     virtual void put_int(int val) = 0;
68 
69     virtual void put_vector(char *val, int num, Vector &vec) = 0;
70     virtual void put_vector(char *val, int num, int width, Vector &vec) = 0;
71 
72     /**
73      * Write the prefix bytes for a vector and reset the state/counter for
74      * a vector/array that will be written using put_vector_part() and
75      * put_vector_end().
76      *
77      * @param num The number of elements to write
78      */
put_vector_start(int)79     virtual void put_vector_start(int /*num*/) {
80         throw InternalErr(__FILE__, __LINE__, "Not Implemented yet");
81     }// = 0;
82 
83     /**
84      * Write one part of a vector's contents.
85      *
86      * @param val Pointer to the part's values
87      * @param num The number of values in this part
88      * @param width The number of bytes per value
89      * @param type The DAP2 data type for each value
90      */
put_vector_part(char *,unsigned int,int,Type)91     virtual void put_vector_part(char */*val*/, unsigned int /*num*/, int /*width*/, Type /*type*/) {
92         throw InternalErr(__FILE__, __LINE__, "Not Implemented yet");
93     }// = 0;
94 
95     /**
96      * Close a vector written using put_vector_part()
97      */
put_vector_end()98     virtual void put_vector_end() {
99         throw InternalErr(__FILE__, __LINE__, "Not Implemented yet");
100     }// = 0;
101 
102     virtual void dump(std::ostream &strm) const = 0;
103 };
104 
105 } // namespace libdap
106 
107 #endif // A_Marshaller_h
108 
109