libdap Updated for version 3.20.8
libdap4 is an implementation of OPeNDAP's DAP protocol.
DDS.h
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#if 0
66#ifndef KEYWORDS_H_
67#include "Keywords2.h"
68#endif
69#endif
70
71#ifndef XMLWRITER_H_
72#include "XMLWriter.h"
73#endif
74
75namespace libdap
76{
77
78bool has_dap2_attributes(BaseType *btp);
79bool has_dap2_attributes(AttrTable &a);
80
183class DDS : public DapObj
184{
185private:
186 BaseTypeFactory *d_factory;
187
188 string d_name; // The dataset d_name
189 string d_filename; // File d_name (or other OS identifier) for
190 string d_container_name; // d_name of container structure
191 Structure *d_container; // current container for container d_name
192 // dataset or part of dataset.
193
194 int d_dap_major; // The protocol major version number
195 int d_dap_minor; // ... and minor version number
196 string d_dap_version; // String version of the protocol
197 string d_request_xml_base;
198 string d_namespace;
199
200 AttrTable d_attr; // Global attributes.
201
202 vector<BaseType *> vars; // Variables at the top level
203
204 int d_timeout; // alarm time in seconds. If greater than
205 // zero, raise the alarm signal if more than
206 // d_timeout seconds are spent reading data.
207#if 0
208 Keywords d_keywords; // Holds keywords parsed from the CE
209#endif
210
211 uint64_t d_max_response_size_kb; // In kilobytes...
212
213 friend class DDSTest;
214
215protected:
216 void duplicate(const DDS &dds);
217 BaseType *leaf_match(const string &name, BaseType::btp_stack *s = 0);
218 BaseType *exact_match(const string &name, BaseType::btp_stack *s = 0);
219
220public:
221 typedef std::vector<BaseType *>::const_iterator Vars_citer ;
222 typedef std::vector<BaseType *>::iterator Vars_iter ;
223 typedef std::vector<BaseType *>::reverse_iterator Vars_riter ;
224
225 DDS(BaseTypeFactory *factory, const string &name = "");
226 DDS(BaseTypeFactory *factory, const string &name, const string &version);
227 DDS(const DDS &dds);
228
229 virtual ~DDS();
230
231 DDS & operator=(const DDS &rhs);
232
233 virtual void transfer_attributes(DAS *das);
234
235 string get_dataset_name() const;
236 void set_dataset_name(const string &n);
237
243 {
244 return d_factory;
245 }
246
254 {
255 BaseTypeFactory *t = d_factory;
256 d_factory = factory;
257 return t;
258 }
259
260 virtual AttrTable &get_attr_table();
261
262 string filename() const;
263 void filename(const string &fn);
264
266 int get_dap_major() const { return d_dap_major; }
268 int get_dap_minor() const { return d_dap_minor; }
269
270 void set_dap_version(const string &version_string = "2.0");
271 string get_dap_version() const { return d_dap_version; }
272 string get_dmr_version() const { return "1.0"; }
273
275 void set_dap_major(int p);
277 void set_dap_minor(int p);
279 void set_dap_version(double d);
280
281#if 0
282 Keywords &get_keywords() {return d_keywords;}
283#endif
284
286 string get_request_xml_base() const { return d_request_xml_base; }
287
289 void set_request_xml_base(const string &xb) { d_request_xml_base = xb; }
290
292 string get_namespace() const { return d_namespace; }
293
295 void set_namespace(const string &ns) { d_namespace = ns; }
296
298 [[deprecated("Use DDS::get_response_limit_kb()")]]
299 long get_response_limit() { return (long)(d_max_response_size_kb * 1024); }
300
305 uint64_t get_response_limit_kb() const { return d_max_response_size_kb; }
306
312 [[deprecated("Use DDS::set_response_limit_kb(uint64_t &size)")]]
313 void set_response_limit(long size) { d_max_response_size_kb = size; }
314
320 void set_response_limit_kb(uint64_t size) { d_max_response_size_kb = size; }
321
325 bool too_big() {
326 return d_max_response_size_kb != 0 && get_request_size_kb(true) > d_max_response_size_kb;
327 }
328
329
331 [[deprecated("Use DDS::get_request_size_kb()")]]
332 int get_request_size(bool constrained);
333
335 uint64_t get_request_size_kb(bool constrained);
336
337 string container_name() ;
338 void container_name( const string &cn ) ;
340
341 void add_var(BaseType *bt);
342 void add_var_nocopy(BaseType *bt);
343
345 void del_var(const string &n);
346
347 BaseType *var(const string &n, BaseType::btp_stack &s);
348 BaseType *var(const string &n, BaseType::btp_stack *s = 0);
349 int num_var();
350
352 Vars_iter var_begin();
353#if 0
355 Vars_citer var_cbegin() const { return vars.cbegin(); }
356#endif
358 Vars_riter var_rbegin();
360 Vars_iter var_end();
361#if 0
363 Vars_citer var_cend() const { return vars.cend(); }
364#endif
366 Vars_riter var_rend();
368 Vars_iter get_vars_iter(int i);
370 BaseType *get_var_index(int i);
372 void insert_var(Vars_iter i, BaseType *ptr);
373 void insert_var_nocopy(Vars_iter i, BaseType *ptr);
375 void del_var(Vars_iter i);
377 void del_var(Vars_iter i1, Vars_iter i2);
378
384 void timeout_on();
385 void timeout_off();
386 void set_timeout(int t);
387 int get_timeout();
389
390 // These parse the DAP2 curly-brace document and make a C++ object.
391 void parse(string fname);
392 void parse(int fd);
393 void parse(FILE *in = stdin);
394
395 // These print the Binary object in either the curly-brace or XML reps
396 void print(FILE *out);
397 void print_constrained(FILE *out);
398 void print_xml(FILE *out, bool constrained, const string &blob = "");
399
400 // Same as above, but using C++ i/o streams
401 void print(ostream &out);
402 void print_constrained(ostream &out);
403 void print_xml(ostream &out, bool constrained, const string &blob = "");
404
405 // Print the XML using libxml2; the other print_xml methods use this impl.
406 void print_xml_writer(ostream &out, bool constrained, const string &blob = "");
407
408 // Print the DAP4 DMR 'object'
409 void print_dmr(ostream &out, bool constrained);
410
411 void print_das(ostream &out);
412 DAS *get_das();
413 void get_das(DAS *das);
414
415 void mark_all(bool state);
416 bool mark(const string &name, bool state);
417 bool check_semantics(bool all = false);
418
420
421 virtual void dump(ostream &strm) const ;
422};
423
424} // namespace libdap
425
426#endif // _dds_h
Contains the attributes for a dataset.
Definition AttrTable.h:143
The basic data type for the DODS DAP types.
Definition BaseType.h:118
Hold attribute data for a DAP2 dataset.
Definition DAS.h:122
void set_dataset_name(const string &n)
Definition DDS.cc:364
void set_dap_major(int p)
Definition DDS.cc:405
void mark_all(bool state)
Definition DDS.cc:1849
void print_dmr(ostream &out, bool constrained)
Print the DAP4 DMR object using a DDS.
Definition DDS.cc:1677
Vars_riter var_rend()
Return a reverse iterator.
Definition DDS.cc:845
void add_var_nocopy(BaseType *bt)
Adds the variable to the DDS.
Definition DDS.cc:641
bool check_semantics(bool all=false)
Check the semantics of each of the variables represented in the DDS.
Definition DDS.cc:1748
void set_namespace(const string &ns)
Set the namespace for this DDS/DDX object/response.
Definition DDS.h:295
string filename() const
Definition DDS.cc:388
virtual AttrTable & get_attr_table()
Definition DDS.cc:373
void set_request_xml_base(const string &xb)
Definition DDS.h:289
void set_response_limit(long size)
Definition DDS.h:313
uint64_t get_request_size_kb(bool constrained)
Get the estimated response size in kilobytes.
Definition DDS.cc:593
virtual void transfer_attributes(DAS *das)
Definition DDS.cc:287
void set_dap_minor(int p)
Definition DDS.cc:424
Vars_riter var_rbegin()
Return a reverse iterator.
Definition DDS.cc:833
string get_namespace() const
Get the namespace associated with the DDS - likely set only by DDX responses.
Definition DDS.h:292
int num_var()
Returns the number of variables in the DDS.
Definition DDS.cc:901
Vars_iter get_vars_iter(int i)
Get an iterator.
Definition DDS.cc:854
void print(FILE *out)
Print the entire DDS to the specified file.
Definition DDS.cc:1051
BaseType * get_var_index(int i)
Get a variable.
Definition DDS.cc:863
int get_request_size(bool constrained)
Get the estimated response size in bytes.
Definition DDS.cc:566
BaseTypeFactory * set_factory(BaseTypeFactory *factory)
Definition DDS.h:253
string get_dataset_name() const
Definition DDS.cc:357
bool too_big()
Definition DDS.h:325
void del_var(const string &n)
Removes a variable from the DDS.
Definition DDS.cc:664
void parse(string fname)
Parse a DDS from a file with the given d_name.
Definition DDS.cc:970
BaseType * var(const string &n, BaseType::btp_stack &s)
Definition DDS.cc:720
void print_xml(FILE *out, bool constrained, const string &blob="")
Definition DDS.cc:1406
void insert_var(Vars_iter i, BaseType *ptr)
Insert a variable before the referenced element.
Definition DDS.cc:873
bool mark(const string &name, bool state)
Mark the send_p flag of the named variable to state.
Definition DDS.cc:1792
int get_dap_minor() const
Get the DAP minor version as sent by the client.
Definition DDS.h:268
uint64_t get_response_limit_kb() const
The maximum allowed response size, in kilobytes. Zero indicates no limit (default).
Definition DDS.h:305
void tag_nested_sequences()
Traverse DDS, set Sequence leaf nodes.
Definition DDS.cc:958
BaseTypeFactory * get_factory() const
Definition DDS.h:242
DAS * get_das()
Get a DAS object.
Definition DDS.cc:1239
void print_constrained(FILE *out)
Print a constrained DDS to the specified file.
Definition DDS.cc:1360
Vars_iter var_begin()
Return an iterator to the first variable.
Definition DDS.cc:827
string container_name()
Definition DDS.cc:512
void insert_var_nocopy(Vars_iter i, BaseType *ptr)
Definition DDS.cc:890
string get_request_xml_base() const
Get the URL that will return this DDS/DDX/DataThing.
Definition DDS.h:286
void set_response_limit_kb(uint64_t size)
Set the maximum response size, in kilobytes. The size is given in kilobytes..
Definition DDS.h:320
int get_dap_major() const
Get the DAP major version as sent by the client.
Definition DDS.h:266
Vars_iter var_end()
Return an iterator.
Definition DDS.cc:839
void set_dap_version(const string &version_string="2.0")
Definition DDS.cc:441
Structure * container()
Definition DDS.cc:548
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:614
void print_xml_writer(ostream &out, bool constrained, const string &blob="")
Definition DDS.cc:1461
long get_response_limit()
Get the maximum response size, in bytes. Zero indicates no limit.
Definition DDS.h:299
void print_das(ostream &out)
write the DAS response given the attribute information in the DDS
Definition DDS.cc:1210
virtual void dump(ostream &strm) const
dumps information about this object
Definition DDS.cc:1863
libdap base object for common functionality of libdap objects
Definition DapObj.h:51
Holds a structure (aggregate) type.
Definition Structure.h:84
top level DAP object to house generic methods
bool has_dap2_attributes(AttrTable &a)
Definition DDS.cc:1081