#include <DataDDS.h>
Public Types | |
| typedef std::vector< BaseType * >::const_iterator | Vars_citer |
| typedef std::vector< BaseType * >::iterator | Vars_iter |
| typedef std::vector< BaseType * >::reverse_iterator | Vars_riter |
Public Member Functions | |
| 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 variable bt and adds the result to this DDS. | |
| void | add_var_nocopy (BaseType *bt) |
| Adds the variable to the DDS. | |
| bool | check_semantics (bool all=false) |
| Check the semantics of each of the variables represented in the DDS. | |
| Structure * | container () |
| string | container_name () |
| void | container_name (const string &cn) |
| DataDDS (BaseTypeFactory *factory, const string &n="", const string &v="", const string &p="") | |
| Make an instance of DataDDS A DataDDS instance is a DDS with additional information about the version of the server from which the data came. | |
| void | del_var (const string &n) |
| Removes a variable from the DDS. | |
| void | del_var (Vars_iter i) |
| Removes a variable from the DDS. | |
| void | del_var (Vars_iter i1, Vars_iter i2) |
| Removes a range of variables from the DDS. | |
| virtual void | dump (ostream &strm) const |
| dumps information about this object | |
| string | filename () const |
| void | filename (const string &fn) |
| virtual AttrTable & | get_attr_table () |
| int | get_dap_major () const |
| Get the DAP major version as sent by the client. | |
| int | get_dap_minor () const |
| Get the DAP minor version as sent by the client. | |
| string | get_dap_version () const |
| DAS * | get_das () |
| Get a DAS object. | |
| void | get_das (DAS *das) |
| string | get_dataset_name () const |
| string | get_dmr_version () const |
| BaseTypeFactory * | get_factory () const |
| string | get_namespace () const |
| Get the namespace associated with the DDS - likely set only by DDX responses. | |
| string | get_protocol () const |
| int | get_protocol_major () const |
| int | get_protocol_minor () const |
| int | get_request_size (bool constrained) |
| Get the estimated response size in bytes. | |
| uint64_t | get_request_size_kb (bool constrained) |
| Get the estimated response size in kilobytes. | |
| string | get_request_xml_base () const |
| Get the URL that will return this DDS/DDX/DataThing. | |
| long | get_response_limit () |
| Get the maximum response size, in bytes. Zero indicates no limit. | |
| uint64_t | get_response_limit_kb () const |
| The maximum allowed response size, in kilobytes. Zero indicates no limit (default). | |
| BaseType * | get_var_index (int i) |
| Get a variable. | |
| Vars_iter | get_vars_iter (int i) |
| Get an iterator. | |
| string | get_version () const |
| Get the server version string, unparsed. | |
| int | get_version_major () const |
| Returns the major version number. | |
| int | get_version_minor () const |
| Returns the minor version number. | |
| void | insert_var (Vars_iter i, BaseType *ptr) |
| Insert a variable before the referenced element. | |
| void | insert_var_nocopy (Vars_iter i, BaseType *ptr) |
| bool | is_dap4_projected (std::vector< string > &inventory) |
| bool | mark (const string &name, bool state) |
| void | mark_all (bool state) |
| Mark the send_p flag of the named variable to state. | |
| int | num_var () |
| Returns the number of variables in the DDS. | |
| void | parse (FILE *in=stdin) |
| Parse a DDS from a file indicated by the input file descriptor. Read the persistent representation of a DDS from the FILE *in, parse it and create a matching binary object. | |
| void | parse (int fd) |
| Parse a DDS from a file indicated by the input file descriptor. | |
| void | parse (string fname) |
| Parse a DDS from a file with the given d_name. | |
| void | print (FILE *out) |
| Print the entire DDS to the specified file. | |
| void | print (ostream &out) |
| Print the entire DDS to the specified ostream. | |
| void | print_constrained (FILE *out) |
| Print a constrained DDS to the specified file. | |
| void | print_constrained (ostream &out) |
| Print a constrained DDS to the specified ostream. | |
| void | print_das (ostream &out) |
| write the DAS response given the attribute information in the DDS | |
| void | print_dmr (ostream &out, bool constrained) |
| Print the DAP4 DMR object using a DDS. | |
| void | print_xml (FILE *out, bool constrained, const string &blob="") |
| void | print_xml (ostream &out, bool constrained, const string &blob="") |
| void | print_xml_writer (ostream &out, bool constrained, const string &blob="") |
| void | set_dap_major (int p) |
| void | set_dap_minor (int p) |
| void | set_dap_version (const string &version_string="2.0") |
| void | set_dap_version (double d) |
| void | set_dataset_name (const string &n) |
| BaseTypeFactory * | set_factory (BaseTypeFactory *factory) |
| void | set_namespace (const string &ns) |
| Set the namespace for this DDS/DDX object/response. | |
| void | set_protocol (const string &p) |
| void | set_request_xml_base (const string &xb) |
| void | set_response_limit (long size) |
| void | set_response_limit_kb (uint64_t size) |
| Set the maximum response size, in kilobytes. The size is given in kilobytes.. | |
| void | set_version (const string &v) |
| void | tag_nested_sequences () |
| Traverse DDS, set Sequence leaf nodes. | |
| bool | too_big () |
| virtual void | transfer_attributes (DAS *das) |
| BaseType * | var (const string &n, BaseType::btp_stack &s) |
| BaseType * | var (const string &n, BaseType::btp_stack *s=0) |
| Find the variable with the given d_name. | |
| Vars_iter | var_begin () |
| Vars_iter | var_end () |
| Return an iterator. | |
| Vars_riter | var_rbegin () |
| Return a reverse iterator. | |
| Vars_riter | var_rend () |
| Return a reverse iterator. | |
| const vector< BaseType * > & | variables () const |
DDS_timeout | |
Old deprecated DDS timeout code | |
| void | timeout_on () |
| void | timeout_off () |
| void | set_timeout (int t) |
| int | get_timeout () |
Protected Member Functions | |
| void | duplicate (const DDS &dds) |
| BaseType * | exact_match (const string &name, BaseType::btp_stack *s=0) |
| BaseType * | leaf_match (const string &name, BaseType::btp_stack *s=0) |
Detailed Description
Holds a DAP2 DDS.
This class adds some useful state information to the DDS structure. It is for use on the client side of the connection.
- Note
- Make sure to pass a valid pointer to the DDS constructor or use the set_factory() method before actually using the DDS. Also make sure that the Factory's lifetime thereafter is the same as the DDS's. Never delete the factory until you're done using the DDS.
- Update: I removed the DEFAULT_BASETYPE_FACTORY switch because it caused more confusion than it avoided. See Trac #130.
- The compile-time symbol DEFAULT_BASETYPE_FACTORY controls whether the old (3.4 and earlier) DDS and DataDDS constructors are supported. These constructors now use a default factory class (BaseTypeFactory, implemented by this library) to instantiate Byte, ..., Grid variables. To use the default ctor in your code you must also define this symbol. If you do choose to define this and fail to provide a specialization of BaseTypeFactory when your software needs one, you code may not link or may fail at run time. In addition to the older ctors for DDS and DataDDS, defining the symbol also makes some of the older methods in Connect available (because those methods require the older DDS and DataDDS ctors.
- See also
- Connect
Member Typedef Documentation
◆ Vars_citer
|
inherited |
◆ Vars_iter
|
inherited |
◆ Vars_riter
|
inherited |
Constructor & Destructor Documentation
◆ DataDDS()
| libdap::DataDDS::DataDDS | ( | BaseTypeFactory * | factory, |
| const string & | n = "", | ||
| const string & | v = "", | ||
| const string & | p = "" ) |
Make an instance of DataDDS A DataDDS instance is a DDS with additional information about the version of the server from which the data came.
- Parameters
-
factory Use this BaseTypeFactory to instantiate the variables. Caller must free; can also be set using the set_factory() method. Never delete until just before deleting the DDS itself unless you intend to replace the factory with a new instance. n The name of the dataset. Can also be set using the set_dataset_name() method. v The server version. p The protocol version.
Definition at line 140 of file DataDDS.cc.
◆ ~DataDDS()
Member Function Documentation
◆ add_var()
|
inherited |
Adds a copy of the variable to the DDS. Using the ptr_duplicate() method, perform a deep copy on the variable bt and adds the result to this DDS.
- Note
- The copy will not copy data values.
- Parameters
-
bt Source variable.
◆ add_var_nocopy()
|
inherited |
◆ check_semantics()
|
inherited |
Check the semantics of each of the variables represented in the DDS.
Check the semantics of the DDS describing a complete dataset. If ALL is true, check not only the semantics of THIS->TABLE, but also recursively all ctor types in the THIS->TABLE. By default, ALL is false since parsing a DDS input file runs semantic checks on all variables (but not the dataset itself.
- Returns
- TRUE if the conventions for the DDS are not violated, FALSE otherwise.
- Parameters
-
all If true, recursively check the individual members of compound variables.
- See also
- BaseType::check_semantics
◆ container()
|
inherited |
◆ container_name() [1/2]
|
inherited |
◆ container_name() [2/2]
|
inherited |
◆ del_var() [1/3]
|
inherited |
Removes a variable from the DDS.
Remove the named variable from the DDS. This method is not smart about looking up names. The variable must exist at the top level of the DDS and must match exactly the d_name given.
- Note
- Invalidates any iterators that reference the contents of the DDS.
- Parameters
-
n The d_name of the variable to remove.
◆ del_var() [2/3]
|
inherited |
◆ del_var() [3/3]
|
inherited |
◆ dump()
|
virtual |
dumps information about this object
Displays the pointer value of this instance and then calls parent dump
- Parameters
-
strm C++ i/o stream to dump the information to
- Returns
- void
Reimplemented from libdap::DDS.
Definition at line 113 of file DataDDS.cc.
◆ duplicate()
|
protectedinherited |
◆ exact_match()
◆ filename() [1/2]
|
inherited |
◆ filename() [2/2]
|
inherited |
◆ get_attr_table()
|
virtualinherited |
◆ get_dap_major()
|
inlineinherited |
◆ get_dap_minor()
|
inlineinherited |
◆ get_dap_version()
◆ get_das() [1/2]
|
inherited |
◆ get_das() [2/2]
◆ get_dataset_name()
|
inherited |
◆ get_dmr_version()
◆ get_factory()
|
inlineinherited |
Return the factory which makes instances of the Byte, ..., Grid type classes. Specialize BaseTypeFactory so that a DDS will be populated with your client or server's specialized types.
- Returns
- An instance of BaseTypeFactory.
◆ get_namespace()
|
inlineinherited |
◆ get_protocol()
◆ get_protocol_major()
◆ get_protocol_minor()
◆ get_request_size()
|
inherited |
Get the estimated response size in bytes.
Get the size of a response. This method looks at the variables in the DDS a computes the number of bytes in the response.
- Note
- This version of the method does a poor job with Sequences. A better implementation would look at row-constraint-based limitations and use them for size computations. If a row-constraint is missing, return an error.
- Parameters
-
constrained Should the size of the whole DDS be used or should the current constraint be taken into account?
- Deprecated
- "Use DDS::get_request_size_kb()"
◆ get_request_size_kb()
|
inherited |
Get the estimated response size in kilobytes.
Get the estimated size of a response in kilobytes. This method looks at the variables in the DDS and computes the number of bytes in the response.
- Note
- This version of the method does a poor job with Sequences. A better implementation would look at row-constraint-based limitations and use them for size computations. If a row-constraint is missing, return an error.
- Parameters
-
constrained Should the size of the whole DDS be used or should the current constraint be taken into account?
◆ get_request_xml_base()
|
inlineinherited |
◆ get_response_limit()
|
inlineinherited |
◆ get_response_limit_kb()
|
inlineinherited |
◆ get_timeout()
◆ get_var_index()
|
inlineinherited |
◆ get_vars_iter()
|
inlineinherited |
◆ get_version()
|
inline |
◆ get_version_major()
|
inline |
◆ get_version_minor()
|
inline |
◆ insert_var()
|
inherited |
◆ insert_var_nocopy()
|
inherited |
◆ is_dap4_projected()
|
inherited |
◆ leaf_match()
◆ mark_all()
|
inherited |
Mark the send_p flag of the named variable to state.
Mark the named variable by setting its SEND_P flag to STATE (true indicates that it is to be sent). Names must be fully qualified.
- Note
- For aggregate types this sets each part to STATE when STATE is True. Thus, if State is True and N is exp1.test', then both exp1' and test' have their SEND_P flag set to True. If STATE is False, then the SEND_P flag of the test' is set to False, but `exp1' is left unchanged. This means that a single variable can be removed from the current projection without removing all the other children of its parent. See the mfunc set_send_p().
- Returns
- True if the named variable was found, false otherwise.
- Todo
- These methods that use the btp_stack to keep track of the path from the top of a dataset to a particular variable can be rewritten to use the parent field instead.
- Todo
- All the methods that use names to identify variables should have counterparts that take BaseType pointers. */ bool DDS::mark(const string &n, bool state) { unique_ptr<BaseType::btp_stack> s(new BaseType::btp_stack);
DBG2(cerr << "DDS::mark: Looking for " << n << endl);
BaseType *variable = var(n, s.get()); if (!variable) { throw Error(malformed_expr, "Could not find variable " + n); }
variable->set_send_p(state);
DBG2(cerr << "DDS::mark: Set variable " << variable->d_name() << " (a " << variable->type_name() << ")" << endl);
Now check the btp_stack and run BaseType::set_send_p for every BaseType pointer on the stack. Using BaseType::set_send_p() will set the property for a Constructor but not its contained variables which preserves the semantics of projecting just one field. while (!s->empty()) { s->top()->BaseType::set_send_p(state);
DBG2(cerr << "DDS::mark: Set variable " << s->top()->d_name() << " (a " << s->top()->type_name() << ")" << endl);
string parent_name = (s->top()->get_parent()) ? s->top()->get_parent()->name() : "none"; string parent_type = (s->top()->get_parent()) ? s->top()->get_parent()->type_name() : "none"; DBG2(cerr << "DDS::mark: Parent variable " << parent_name << " (a " << parent_type << ")" << endl);
s->pop(); }
return true; }
/** Mark the member variable send_p flags to state.
- Returns
- Void
◆ num_var()
|
inherited |
◆ parse() [1/3]
|
inherited |
Parse a DDS from a file indicated by the input file descriptor. Read the persistent representation of a DDS from the FILE *in, parse it and create a matching binary object.
- Parameters
-
in Read the persistent DDS from this FILE*.
- Exceptions
-
InternalErr Thrown if inis nullError Thrown if the parse fails.
◆ parse() [2/3]
|
inherited |
◆ parse() [3/3]
|
inherited |
◆ print() [1/2]
|
inherited |
◆ print() [2/2]
|
inherited |
◆ print_constrained() [1/2]
|
inherited |
◆ print_constrained() [2/2]
|
inherited |
◆ print_das()
|
inherited |
◆ print_dmr()
|
inherited |
Print the DAP4 DMR object using a DDS.
This method prints the DMR from a DDS. If the dap version is not >= 4.0, it's an error to call this method.
- Note
- Calling methods that print the DDS or DDX when get_dap_major() returns a value >= 4 is undefined. Use this method to get the DAP4 metadata response.
- Parameters
-
out Write the XML to this stream constrained Should the DMR be subject to a constraint?
◆ print_xml() [1/2]
|
inherited |
Print an XML representation of this DDS. This method is used to generate the part of the DDX response. The Dataset tag is not written by this code. The caller of this method must handle writing that and including the dataBLOB tag.
- Parameters
-
out Destination. constrained True if the output should be limited to just those variables that are in the projection of the current constraint expression. blob The dataBLOB href.
◆ print_xml() [2/2]
Print an XML representation of this DDS. This method is used to generate the DDX response. The Dataset tag is not written by this code. The caller of this method must handle writing that and including the dataBLOB tag.
- Parameters
-
out Destination ostream. constrained True if the output should be limited to just those variables that are in the projection of the current constraint expression. blob The dataBLOB href.
◆ print_xml_writer()
|
inherited |
Print the DDX. This code uses the libxml2 'TextWriter' interface; something that seems to be a good compromise between doing it by hand (although more verbose it is also more reliable) and DOM.
- Note
- This code handles several different versions of DAP in a fairly crude way. I've broken it up into three different responses: DAP2, DAP3.2 and DAP4.
- Parameters
-
out Write the XML to this output sink constrained True if the only variables to print are those in the current projection. If true, this will also suppress printing attributes. blob This is an href (DAP2) or a cid (DAP3.4 and 4). The href points to the binary data; the cid is the M-MIME separator for the binary data.
◆ set_dap_major()
|
inherited |
◆ set_dap_minor()
|
inherited |
◆ set_dap_version() [1/2]
|
inherited |
◆ set_dap_version() [2/2]
|
inherited |
Old way to set the DAP version.
- Note
- Don't use this - two interfaces to set the version number is overkill
- Parameters
-
d The protocol version requested by the client, as a double.
◆ set_dataset_name()
|
inherited |
◆ set_factory()
|
inlineinherited |
◆ set_namespace()
|
inlineinherited |
◆ set_protocol()
|
inline |
◆ set_request_xml_base()
|
inlineinherited |
- See also
- get_request_xml_base
◆ set_response_limit()
|
inlineinherited |
◆ set_response_limit_kb()
|
inlineinherited |
◆ set_timeout()
◆ set_version()
|
inline |
◆ tag_nested_sequences()
|
inherited |
◆ timeout_off()
◆ timeout_on()
◆ too_big()
|
inlineinherited |
◆ transfer_attributes()
|
virtualinherited |
This is the main method used to transfer attributes from a DAS object into a DDS. This uses the BaseType::transfer_attributes() method and the various implementations found here (in the constructors classes) and in handlers.
This method uses a deep copy to transfer the attributes, so it is safe to delete the source DAS object passed to this method once it is done.
- Note
- To accommodate oddly built DAS objects produced by various handlers, specialize the methods there.
- Parameters
-
das Transfer (copy) attributes from this DAS object.
◆ var() [1/2]
Search for for variable n as above but record all compound type variables which ultimately contain n on s. This stack can then be used to mark the contained compound-type variables as part of the current projection.
- Returns
- A BaseType pointer to the variable n or 0 if n could not be found.
◆ var() [2/2]
Find the variable with the given d_name.
Returns a pointer to the named variable. If the d_name contains one or more field separators then the function looks for a variable whose name matches exactly. If the d_name contains no field separators then the function looks first in the top level and then in all subsequent levels and returns the first occurrence found. In general, this function searches constructor types in the order in which they appear in the DDS, but there is no requirement that it do so.
- Note
- If a dataset contains two constructor types which have field names that are the same (say point.x and pair.x) you should use fully qualified names to get each of those variables.
- Parameters
-
n The name of the variable to find. s If given, this value-result parameter holds the path to the returned BaseType. Thus, this method can return the FQN for the variable n.
- Returns
- A BaseType pointer to the variable or null if not found.
◆ var_begin()
|
inlineinherited |
Return an iterator to the first variable
- See also
- vars()
◆ var_end()
|
inlineinherited |
◆ var_rbegin()
|
inlineinherited |
◆ var_rend()
|
inlineinherited |
◆ variables()
The documentation for this class was generated from the following files:
