libdap++  Updated for version 3.14.0
DDS.h
Go to the documentation of this file.
1 // -*- mode: c++; c-basic-offset:4 -*-
2 
3 // This file is part of libdap, A C++ implementation of the OPeNDAP Data
4 // Access Protocol.
5 
6 // Copyright (c) 2002,2003 OPeNDAP, Inc.
7 // Author: James Gallagher <jgallagher@opendap.org>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
24 
25 // (c) COPYRIGHT URI/MIT 1994-1999
26 // Please read the full copyright statement in the file COPYRIGHT_URI.
27 //
28 // Authors:
29 // jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
30 
31 // Provide access to the DDS. This class is used to parse DDS text files, to
32 // produce a printed representation of the in-memory variable table, and to
33 // update the table on a per-variable basis.
34 //
35 // jhrg 9/8/94
36 
37 #ifndef _dds_h
38 #define _dds_h 1
39 
40 #include <cstdio>
41 #include <iostream>
42 #include <string>
43 #include <vector>
44 
45 #ifndef _basetype_h
46 #include "BaseType.h"
47 #endif
48 
49 #ifndef _constructor_h
50 #include "Constructor.h"
51 #endif
52 
53 #ifndef base_type_factory_h
54 #include "BaseTypeFactory.h"
55 #endif
56 
57 #ifndef _das_h
58 #include "DAS.h"
59 #endif
60 
61 #ifndef A_DapObj_h
62 #include "DapObj.h"
63 #endif
64 
65 #ifndef KEYWORDS_H_
66 #include "Keywords2.h"
67 #endif
68 
69 #ifndef XMLWRITER_H_
70 #include "XMLWriter.h"
71 #endif
72 
73 using std::cout;
74 
75 namespace libdap
76 {
77 
180 class DDS : public DapObj
181 {
182 private:
183  BaseTypeFactory *d_factory;
184 
185  string d_name; // The dataset d_name
186  string d_filename; // File d_name (or other OS identifier) for
187  string d_container_name; // d_name of container structure
188  Structure *d_container; // current container for container d_name
189  // dataset or part of dataset.
190 
191  int d_dap_major; // The protocol major version number
192  int d_dap_minor; // ... and minor version number
193  string d_dap_version; // String version of the protocol
194  string d_request_xml_base;
195  string d_namespace;
196 
197  AttrTable d_attr; // Global attributes.
198 
199  vector<BaseType *> vars; // Variables at the top level
200 
201  int d_timeout; // alarm time in seconds. If greater than
202  // zero, raise the alarm signal if more than
203  // d_timeout seconds are spent reading data.
204  Keywords d_keywords; // Holds keywords parsed from the CE
205 
206  long d_max_response_size; // In bytes...
207 
208 
209 
210  friend class DDSTest;
211 
212 protected:
213  void duplicate(const DDS &dds);
214  BaseType *leaf_match(const string &name, BaseType::btp_stack *s = 0);
215  BaseType *exact_match(const string &name, BaseType::btp_stack *s = 0);
216 
217 public:
218  typedef std::vector<BaseType *>::const_iterator Vars_citer ;
219  typedef std::vector<BaseType *>::iterator Vars_iter ;
220  typedef std::vector<BaseType *>::reverse_iterator Vars_riter ;
221 
222  DDS(BaseTypeFactory *factory, const string &name = "");
223  DDS(BaseTypeFactory *factory, const string &name, const string &version);
224  DDS(const DDS &dds);
225 
226  virtual ~DDS();
227 
228  DDS & operator=(const DDS &rhs);
229 
230  virtual void transfer_attributes(DAS *das);
231 
232  string get_dataset_name() const;
233  void set_dataset_name(const string &n);
234 
240  {
241  return d_factory;
242  }
243 
251  {
252  BaseTypeFactory *t = d_factory;
253  d_factory = factory;
254  return t;
255  }
256 
257  virtual AttrTable &get_attr_table();
258 
259  string filename() const;
260  void filename(const string &fn);
261 
263  int get_dap_major() const { return d_dap_major; }
265  int get_dap_minor() const { return d_dap_minor; }
266 
267  void set_dap_version(const string &version_string = "2.0");
268  string get_dap_version() const { return d_dap_version; }
269  string get_dmr_version() const { return "1.0"; }
270 
272  void set_dap_major(int p);
274  void set_dap_minor(int p);
276  void set_dap_version(double d);
277 
278  Keywords &get_keywords() { return d_keywords; }
279 
281  string get_request_xml_base() const { return d_request_xml_base; }
282 
284  void set_request_xml_base(const string &xb) { d_request_xml_base = xb; }
285 
287  string get_namespace() const { return d_namespace; }
288 
290  void set_namespace(const string &ns) { d_namespace = ns; }
291 
293  long get_response_limit() { return d_max_response_size; }
294 
298  void set_response_limit(long size) { d_max_response_size = size * 1024; }
299 
301  int get_request_size(bool constrained);
302 
303  string container_name() ;
304  void container_name( const string &cn ) ;
305  Structure *container() ;
306 
307  void add_var(BaseType *bt);
308  void add_var_nocopy(BaseType *bt);
309 
311  void del_var(const string &n);
312 
313  BaseType *var(const string &n, BaseType::btp_stack &s);
314  BaseType *var(const string &n, BaseType::btp_stack *s = 0);
315  int num_var();
316 
318  Vars_iter var_begin();
319 #if 0
320  Vars_citer var_cbegin() const { return vars.cbegin(); }
322 #endif
323  Vars_riter var_rbegin();
326  Vars_iter var_end();
327 #if 0
328  Vars_citer var_cend() const { return vars.cend(); }
330 #endif
331  Vars_riter var_rend();
334  Vars_iter get_vars_iter(int i);
336  BaseType *get_var_index(int i);
338  void insert_var(Vars_iter i, BaseType *ptr);
339  void insert_var_nocopy(Vars_iter i, BaseType *ptr);
341  void del_var(Vars_iter i);
343  void del_var(Vars_iter i1, Vars_iter i2);
344 
345  void timeout_on();
346  void timeout_off();
347  void set_timeout(int t);
348  int get_timeout();
349 
350  // These parse the DAP2 curly-brace document and make a C++ object.
351  void parse(string fname);
352  void parse(int fd);
353  void parse(FILE *in = stdin);
354 
355  // These print the Binary object in either the curly-brace or XML reps
356  void print(FILE *out);
357  void print_constrained(FILE *out);
358  void print_xml(FILE *out, bool constrained, const string &blob = "");
359 
360  // Same as above, but using C++ i/o streams
361  void print(ostream &out);
362  void print_constrained(ostream &out);
363  void print_xml(ostream &out, bool constrained, const string &blob = "");
364 
365  // Print the XML using libxml2; the other print_xml methods use this impl.
366  void print_xml_writer(ostream &out, bool constrained, const string &blob = "");
367 
368  // Print the DAP4 DMR 'object'
369  void print_dmr(ostream &out, bool constrained);
370 
371  void print_das(ostream &out);
372 
373  void mark_all(bool state);
374  bool mark(const string &name, bool state);
375  bool check_semantics(bool all = false);
376 
377  void tag_nested_sequences();
378 
379  virtual void dump(ostream &strm) const ;
380 };
381 
382 } // namespace libdap
383 
384 #endif // _dds_h
void print(FILE *out)
Print the entire DDS to the specified file.
Definition: DDS.cc:1006
string filename() const
Definition: DDS.cc:389
void insert_var_nocopy(Vars_iter i, BaseType *ptr)
Definition: DDS.cc:869
Contains the attributes for a dataset.
Definition: AttrTable.h:142
string get_dmr_version() const
Definition: DDS.h:269
Vars_iter get_vars_iter(int i)
Get an iterator.
Definition: DDS.cc:833
void set_response_limit(long size)
Definition: DDS.h:298
BaseType * leaf_match(const string &name, BaseType::btp_stack *s=0)
Definition: DDS.cc:737
void insert_var(Vars_iter i, BaseType *ptr)
Insert a variable before the referenced element.
Definition: DDS.cc:852
Vars_iter var_begin()
Return an iterator to the first variable.
Definition: DDS.cc:806
long get_response_limit()
Get the maximum response size, in KB. Zero indicates no limit.
Definition: DDS.h:293
string get_request_xml_base() const
Get the URL that will return this DDS/DDX/DataThing.
Definition: DDS.h:281
void set_timeout(int t)
Definition: DDS.cc:902
DDS(BaseTypeFactory *factory, const string &name="")
Definition: DDS.cc:206
int get_request_size(bool constrained)
Get the estimated response size.
Definition: DDS.cc:567
BaseType * var(const string &n, BaseType::btp_stack &s)
Definition: DDS.cc:699
virtual void transfer_attributes(DAS *das)
Definition: DDS.cc:288
void print_xml(FILE *out, bool constrained, const string &blob="")
Definition: DDS.cc:1107
friend class DDSTest
Definition: DDS.h:210
std::vector< BaseType * >::const_iterator Vars_citer
Definition: DDS.h:218
void timeout_off()
Definition: DDS.cc:894
void print_xml_writer(ostream &out, bool constrained, const string &blob="")
Definition: DDS.cc:1162
void add_var_nocopy(BaseType *bt)
Adds the variable to the DDS.
Definition: DDS.cc:615
Holds a structure (aggregate) type.
Definition: Structure.h:83
Vars_riter var_rend()
Return a reverse iterator.
Definition: DDS.cc:824
int num_var()
Returns the number of variables in the DDS.
Definition: DDS.cc:880
std::vector< BaseType * >::reverse_iterator Vars_riter
Definition: DDS.h:220
stack< BaseType * > btp_stack
Definition: BaseType.h:149
bool mark(const string &name, bool state)
Mark the send_p flag of the named variable to state.
Definition: DDS.cc:1430
void parse(string fname)
Parse a DDS from a file with the given d_name.
Definition: DDS.cc:929
DDS & operator=(const DDS &rhs)
Definition: DDS.cc:263
const char * version
Definition: getdap.cc:60
string get_namespace() const
Get the namespace associated with the DDS - likely set only by DDX responses.
Definition: DDS.h:287
virtual ~DDS()
Definition: DDS.cc:253
string get_dap_version() const
Definition: DDS.h:268
int get_dap_major() const
Get the DAP major version as sent by the client.
Definition: DDS.h:263
void mark_all(bool state)
Definition: DDS.cc:1477
Keywords & get_keywords()
Definition: DDS.h:278
std::vector< BaseType * >::iterator Vars_iter
Definition: DDS.h:219
void print_das(ostream &out)
Definition: DDS.cc:1038
void print_dmr(ostream &out, bool constrained)
Definition: DDS.cc:1295
virtual AttrTable & get_attr_table()
Definition: DDS.cc:374
BaseType * get_var_index(int i)
Get a variable.
Definition: DDS.cc:842
bool check_semantics(bool all=false)
Check the semantics of each of the variables represented in the DDS.
Definition: DDS.cc:1384
Structure * container()
Definition: DDS.cc:549
string container_name()
Definition: DDS.cc:513
void timeout_on()
Definition: DDS.cc:886
BaseTypeFactory * set_factory(BaseTypeFactory *factory)
Definition: DDS.h:250
Vars_iter var_end()
Return an iterator.
Definition: DDS.cc:818
BaseType * exact_match(const string &name, BaseType::btp_stack *s=0)
Definition: DDS.cc:773
BaseTypeFactory * get_factory() const
Definition: DDS.h:239
void set_namespace(const string &ns)
Set the namespace for this DDS/DDX object/response.
Definition: DDS.h:290
void tag_nested_sequences()
Traverse DDS, set Sequence leaf nodes.
Definition: DDS.cc:917
void set_dap_minor(int p)
Definition: DDS.cc:425
void set_dataset_name(const string &n)
Definition: DDS.cc:365
The basic data type for the DODS DAP types.
Definition: BaseType.h:117
libdap base object for common functionality of libdap objects
Definition: DapObj.h:55
void del_var(const string &n)
Removes a variable from the DDS.
Definition: DDS.cc:643
Vars_riter var_rbegin()
Return a reverse iterator.
Definition: DDS.cc:812
Hold attribute data for a DAP2 dataset.
Definition: DAS.h:121
int get_dap_minor() const
Get the DAP minor version as sent by the client.
Definition: DDS.h:265
string get_dataset_name() const
Definition: DDS.cc:358
void duplicate(const DDS &dds)
Definition: DDS.cc:133
void set_dap_major(int p)
Definition: DDS.cc:406
int get_timeout()
Definition: DDS.cc:909
void print_constrained(FILE *out)
Print a constrained DDS to the specified file.
Definition: DDS.cc:1061
virtual void dump(ostream &strm) const
dumps information about this object
Definition: DDS.cc:1491
void set_dap_version(const string &version_string="2.0")
Definition: DDS.cc:442
void add_var(BaseType *bt)
Adds a copy of the variable to the DDS. Using the ptr_duplicate() method, perform a deep copy on the ...
Definition: DDS.cc:588
void set_request_xml_base(const string &xb)
Definition: DDS.h:284