libdap++  Updated for version 3.12.0
Array.h
Go to the documentation of this file.
1 
2 // -*- mode: c++; c-basic-offset:4 -*-
3 
4 // This file is part of libdap, A C++ implementation of the OPeNDAP Data
5 // Access Protocol.
6 
7 // Copyright (c) 2002,2003 OPeNDAP, Inc.
8 // Author: James Gallagher <jgallagher@opendap.org>
9 //
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Lesser General Public
12 // License as published by the Free Software Foundation; either
13 // version 2.1 of the License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 //
24 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
25 
26 // (c) COPYRIGHT URI/MIT 1994-1999
27 // Please read the full copyright statement in the file COPYRIGHT_URI.
28 //
29 // Authors:
30 // jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
31 
32 // Class for array variables. The dimensions of the array are stored in the
33 // list SHAPE.
34 //
35 // jhrg 9/6/94
36 
37 #ifndef _array_h
38 #define _array_h 1
39 
40 #include <string>
41 #include <vector>
42 
43 #ifndef _dods_limits_h
44 #include "dods-limits.h"
45 #endif
46 
47 #ifndef _vector_h
48 #include "Vector.h"
49 #endif
50 
51 #ifndef XMLWRITER_H_
52 #include "XMLWriter.h"
53 #endif
54 
55 namespace libdap
56 {
57 
59 
103 class Array: public Vector
104 {
105 public:
116  struct dimension
117  {
118  int size;
119  string name;
120  int start;
121  int stop;
122  int stride;
123  int c_size;
124  };
125 
126 private:
127  std::vector<dimension> _shape; // list of dimensions (i.e., the shape)
128 
129  friend class ArrayTest;
130 
131 protected:
132  void _duplicate(const Array &a);
133 
134  unsigned int print_array(FILE *out, unsigned int index,
135  unsigned int dims, unsigned int shape[]);
136 
137  unsigned int print_array(ostream &out, unsigned int index,
138  unsigned int dims, unsigned int shape[]);
139 
140 public:
146  typedef std::vector<dimension>::const_iterator Dim_citer ;
153  typedef std::vector<dimension>::iterator Dim_iter ;
154 
155  Array(const string &n, BaseType *v);
156  Array(const string &n, const string &d, BaseType *v);
157  Array(const Array &rhs);
158  virtual ~Array();
159 
160  Array &operator=(const Array &rhs);
161  virtual BaseType *ptr_duplicate();
162 
163  void add_var(BaseType *v, Part p = nil);
164  void add_var_nocopy(BaseType *v, Part p = nil);
165 
166  void append_dim(int size, string name = "");
167  void prepend_dim(int size, const string& name = "");
168  void clear_all_dims();
169 
170  virtual void add_constraint(Dim_iter i, int start, int stride, int stop);
171  virtual void reset_constraint();
172 
173  virtual void clear_constraint();
174 
175  virtual void update_length(int size);
176  virtual unsigned int width(bool constrained = false);
177 
178  Dim_iter dim_begin() ;
179  Dim_iter dim_end() ;
180 
181  virtual int dimension_size(Dim_iter i, bool constrained = false);
182  virtual int dimension_start(Dim_iter i, bool constrained = false);
183  virtual int dimension_stop(Dim_iter i, bool constrained = false);
184  virtual int dimension_stride(Dim_iter i, bool constrained = false);
185  virtual string dimension_name(Dim_iter i);
186 
187  virtual unsigned int dimensions(bool constrained = false);
188 
189  virtual void print_decl(ostream &out, string space = " ",
190  bool print_semi = true,
191  bool constraint_info = false,
192  bool constrained = false);
193 
194  virtual void print_xml(ostream &out, string space = " ",
195  bool constrained = false);
196 
197  virtual void print_xml_writer(XMLWriter &xml, bool constrained = false);
198  virtual void print_xml_writer_core(XMLWriter &out, bool constrained, string tag);
199  virtual void print_as_map_xml_writer(XMLWriter &xml, bool constrained);
200 
201  virtual void print_xml_core(FILE *out, string space, bool constrained, string tag);
202  virtual void print_xml_core(ostream &out, string space, bool constrained, string tag);
203 
204  // not used (?)
205  virtual void print_as_map_xml(ostream &out, string space = " ",
206  bool constrained = false);
207 
208  virtual void print_val(ostream &out, string space = "",
209  bool print_decl_p = true);
210 
211  virtual void print_xml(FILE *out, string space = " ",
212  bool constrained = false);
213  virtual void print_as_map_xml(FILE *out, string space = " ",
214  bool constrained = false);
215  virtual void print_val(FILE *out, string space = "",
216  bool print_decl_p = true);
217  virtual void print_decl(FILE *out, string space = " ",
218  bool print_semi = true,
219  bool constraint_info = false,
220  bool constrained = false);
221 
222  virtual bool check_semantics(string &msg, bool all = false);
223 
224  virtual void dump(ostream &strm) const ;
225 };
226 
227 } // namespace libdap
228 
229 #endif // _array_h
virtual void print_xml_writer(XMLWriter &xml, bool constrained=false)
Definition: Array.cc:719
virtual void reset_constraint()
Reset constraint to select entire array.
Definition: Array.cc:303
virtual void add_constraint(Dim_iter i, int start, int stride, int stop)
Adds a constraint to an Array dimension.
Definition: Array.cc:359
virtual bool check_semantics(string &msg, bool all=false)
Check semantic features of the Array.
Definition: Array.cc:896
virtual void print_xml_core(FILE *out, string space, bool constrained, string tag)
Definition: Array.cc:700
virtual unsigned int dimensions(bool constrained=false)
Return the total number of dimensions in the array.
Definition: Array.cc:413
Part
Names the parts of multi-section constructor data types.
Definition: BaseType.h:95
void add_var(BaseType *v, Part p=nil)
Add the BaseType pointer to this constructor type instance.
Definition: Array.cc:181
int stop
The constraint end index.
Definition: Array.h:121
Holds a one-dimensional collection of DAP2 data types.
Definition: Vector.h:78
std::vector< dimension >::const_iterator Dim_citer
Definition: Array.h:146
int start
The constraint start index.
Definition: Array.h:120
Array & operator=(const Array &rhs)
Definition: Array.cc:144
void _duplicate(const Array &a)
Definition: Array.cc:54
Dim_iter dim_end()
Definition: Array.cc:398
virtual void print_as_map_xml(ostream &out, string space=" ", bool constrained=false)
Definition: Array.cc:689
friend class ArrayTest
Definition: Array.h:129
virtual int dimension_size(Dim_iter i, bool constrained=false)
Returns the size of the dimension.
Definition: Array.cc:446
virtual unsigned int width(bool constrained=false)
Returns the width of the data, in bytes.
Definition: Array.cc:563
void append_dim(int size, string name="")
Add a dimension of a given size.
Definition: Array.cc:243
std::vector< dimension >::iterator Dim_iter
Definition: Array.h:153
void clear_all_dims()
Definition: Array.cc:292
virtual string dimension_name(Dim_iter i)
Returns the name of the specified dimension.
Definition: Array.cc:544
virtual BaseType * ptr_duplicate()
Definition: Array.cc:138
virtual int dimension_stride(Dim_iter i, bool constrained=false)
Returns the stride value of the constraint.
Definition: Array.cc:528
int stride
The constraint stride.
Definition: Array.h:122
virtual void print_decl(ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
Prints a DDS entry for the Array.
Definition: Array.cc:625
int c_size
Size of dimension once constrained.
Definition: Array.h:123
virtual void print_as_map_xml_writer(XMLWriter &xml, bool constrained)
Definition: Array.cc:725
void prepend_dim(int size, const string &name="")
Definition: Array.cc:268
string name() const
Returns the name of the class instance.
Definition: BaseType.cc:254
virtual void print_xml(ostream &out, string space=" ", bool constrained=false)
Definition: Array.cc:667
Array(const string &n, BaseType *v)
Array constructor.
Definition: Array.cc:100
virtual int dimension_stop(Dim_iter i, bool constrained=false)
Return the stop index of the constraint.
Definition: Array.cc:503
virtual void dump(ostream &strm) const
dumps information about this object
Definition: Array.cc:915
virtual int dimension_start(Dim_iter i, bool constrained=false)
Return the start index of a dimension.
Definition: Array.cc:479
virtual ~Array()
The Array destructor.
Definition: Array.cc:131
int size
The unconstrained dimension size.
Definition: Array.h:118
string name
The name of this dimension.
Definition: Array.h:119
const int DODS_MAX_ARRAY
Definition: Array.h:58
The basic data type for the DODS DAP types.
Definition: BaseType.h:199
Dim_iter dim_begin()
Definition: Array.cc:391
void add_var_nocopy(BaseType *v, Part p=nil)
Definition: Array.cc:207
virtual void update_length(int size)
Definition: Array.cc:72
virtual void print_xml_writer_core(XMLWriter &out, bool constrained, string tag)
Definition: Array.cc:757
unsigned int print_array(FILE *out, unsigned int index, unsigned int dims, unsigned int shape[])
Print the value given the current constraint.
Definition: Array.cc:795
A multidimensional array of identical data types.
Definition: Array.h:103
virtual void print_val(ostream &out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition: Array.cc:859
#define DODS_INT_MAX
Definition: dods-limits.h:73
virtual void clear_constraint()
Clears the projection; add each projected dimension explicitly using add_constraint.
Definition: Array.cc:328