#include <DataDDS.h>
Inheritance diagram for libdap::DataDDS:
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. | |
bool | check_semantics (bool all=false) |
Check the semantics of each of the variables represented in the DDS. | |
DataDDS (BaseTypeFactory *factory, const string &n="", const string &v="", const string &p="") | |
Make an instance of DataDDS A DataDDS instance is a DDS with aditional information about the version of the server from which the data came. | |
void | del_var (Vars_iter i1, Vars_iter i2) |
Removes a range of variables from the DDS. | |
void | del_var (Vars_iter i) |
Removes a variable from the DDS. | |
void | del_var (const string &n) |
Removes a variable from the DDS. | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual AttrTable & | get_attr_table () |
BaseTypeFactory * | get_factory () const |
string | get_protocol () const |
int | get_protocol_major () const |
int | get_protocol_minor () const |
int | get_timeout () |
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. | |
bool | mark (const string &name, bool state) |
Mark the send_p flag of the named variable to state. | |
void | mark_all (bool 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 name. | |
void | print (ostream &out) |
Print the entire DDS to the specified ostream. | |
void | print (FILE *out) |
Print the entire DDS to the specified file. | |
void | print_constrained (ostream &out) |
Print a constrained DDS to the specified ostream. | |
void | print_constrained (FILE *out) |
Print a constrained DDS to the specified file. | |
void | print_xml (ostream &out, bool constrained, const string &blob) |
void | print_xml (FILE *out, bool constrained, const string &blob) |
BaseTypeFactory * | set_factory (BaseTypeFactory *factory) |
void | set_protocol (const string &p) |
void | set_timeout (int t) |
void | set_version (const string &v) |
void | tag_nested_sequences () |
Traverse DDS, set Sequence leaf nodes. | |
void | timeout_off () |
void | timeout_on () |
virtual void | transfer_attributes (DAS *das) |
BaseType * | var (const string &n, BaseType::btp_stack *s=0) |
Find the variable with the given name. | |
BaseType * | var (const string &n, BaseType::btp_stack &s) |
Vars_iter | var_begin () |
Returns the first variable in the DDS. | |
Vars_iter | var_end () |
Return an iterator. | |
Vars_riter | var_rbegin () |
Return a reverse iterator. | |
Vars_riter | var_rend () |
Return a reverse iterator. | |
virtual | ~DataDDS () |
File Name Accessor | |
Get and set the dataset's filename. This is the physical location on a disk where the dataset exists. The dataset name is simply a title.
| |
void | filename (const string &fn) |
string | filename () |
Dataset Name Accessors | |
Get and set the dataset's name. This is the name of the dataset itself, and is not to be confused with the name of the file or disk on which it is stored. | |
string | get_dataset_name () const |
void | set_dataset_name (const string &n) |
Protected Member Functions | |
void | duplicate (const DDS &dds) |
BaseType * | exact_match (const string &name, BaseType::btp_stack *s=0) |
virtual AttrTable * | find_matching_container (AttrTable::entry *source, BaseType **dest_variable) |
BaseType * | leaf_match (const string &name, BaseType::btp_stack *s=0) |
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.
Definition at line 77 of file DataDDS.h.
typedef std::vector<BaseType *>::const_iterator libdap::DDS::Vars_citer [inherited] |
typedef std::vector<BaseType *>::iterator libdap::DDS::Vars_iter [inherited] |
typedef std::vector<BaseType *>::reverse_iterator libdap::DDS::Vars_riter [inherited] |
libdap::DataDDS::DataDDS | ( | BaseTypeFactory * | factory, | |
const string & | n = "" , |
|||
const string & | v = "" , |
|||
const string & | p = "" | |||
) |
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 istelf 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 163 of file DataDDS.cc.
void libdap::DDS::add_var | ( | BaseType * | bt | ) | [inherited] |
bt | Source variable. |
Definition at line 351 of file DDS.cc.
References DBG2, and libdap::BaseType::ptr_duplicate().
Referenced by libdap::DDS::duplicate().
Here is the call graph for this function:
bool libdap::DDS::check_semantics | ( | bool | all = false |
) | [inherited] |
Check the semantics of the DDS describing a complete dataset. If ALL is true, check not only the semantics of THIS->TABLE, but also recurrsively all ctor types in the THIS->TABLE. By default, ALL is false since parsing a DDS input file runns semantic checks on all variables (but not the dataset itself.
all | If true, recursively check the individual members of compound variables. |
Definition at line 873 of file DDS.cc.
References libdap::unique_names().
Here is the call graph for this function:
void libdap::DDS::del_var | ( | Vars_iter | i | ) | [inherited] |
void libdap::DDS::del_var | ( | const string & | n | ) | [inherited] |
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 name given.
n | The name of the variable to remove. |
void libdap::DataDDS::dump | ( | ostream & | strm | ) | const [virtual] |
Displays the pointer value of this instance and then calls parent dump
strm | C++ i/o stream to dump the information to |
Reimplemented from libdap::DDS.
Definition at line 128 of file DataDDS.cc.
References libdap::DDS::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().
Here is the call graph for this function:
void libdap::DDS::duplicate | ( | const DDS & | dds | ) | [protected, inherited] |
Definition at line 86 of file DDS.cc.
References libdap::DDS::add_var(), libdap::DDS::d_factory, libdap::DDS::name, libdap::DDS::var_begin(), and libdap::DDS::var_end().
Referenced by libdap::DDS::DDS(), and libdap::DDS::operator=().
Here is the call graph for this function:
BaseType * libdap::DDS::exact_match | ( | const string & | name, | |
BaseType::btp_stack * | s = 0 | |||
) | [protected, inherited] |
Definition at line 475 of file DDS.cc.
References DBG2, libdap::BaseType::name(), libdap::BaseType::var(), and libdap::DDS::var().
Referenced by libdap::DDS::var().
Here is the call graph for this function:
void libdap::DDS::filename | ( | const string & | fn | ) | [inherited] |
string libdap::DDS::filename | ( | ) | [inherited] |
AttrTable * libdap::DDS::find_matching_container | ( | AttrTable::entry * | source, | |
BaseType ** | dest_variable | |||
) | [protected, virtual, inherited] |
Given an attribute container from a DAS, find or make a destination for its contents in the DDS.
source | Attribute table | |
dest_variable | result param that holds the BaseType |
Definition at line 182 of file DDS.cc.
References libdap::AttrTable::append_container(), libdap::Attr_container, DBG, libdap::dods_grid_c, libdap::AttrTable::find_container(), libdap::BaseType::get_attr_table(), libdap::BaseType::get_parent(), libdap::AttrTable::entry::name, libdap::BaseType::type(), libdap::AttrTable::entry::type, and libdap::DDS::var().
Referenced by libdap::DDS::transfer_attributes().
Here is the call graph for this function:
AttrTable & libdap::DDS::get_attr_table | ( | ) | [virtual, inherited] |
Get the attribute table for the global attributes.
Definition at line 317 of file DDS.cc.
Referenced by libdap::DDXParser::ddx_start_document().
string libdap::DDS::get_dataset_name | ( | ) | const [inherited] |
BaseTypeFactory* libdap::DDS::get_factory | ( | ) | const [inline, inherited] |
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.
Definition at line 236 of file DDS.h.
Referenced by libdap::Connect::request_ddx().
string libdap::DataDDS::get_protocol | ( | ) | const [inline] |
int libdap::DataDDS::get_protocol_major | ( | ) | const [inline] |
int libdap::DataDDS::get_protocol_minor | ( | ) | const [inline] |
BaseType * libdap::DDS::get_var_index | ( | int | i | ) | [inherited] |
DDS::Vars_iter libdap::DDS::get_vars_iter | ( | int | i | ) | [inherited] |
BaseType * libdap::DDS::leaf_match | ( | const string & | name, | |
BaseType::btp_stack * | s = 0 | |||
) | [protected, inherited] |
bool libdap::DDS::mark | ( | const string & | n, | |
bool | state | |||
) | [inherited] |
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.
Definition at line 919 of file DDS.cc.
References DBG2, libdap::BaseType::name(), libdap::BaseType::set_send_p(), and libdap::DDS::var().
Here is the call graph for this function:
void libdap::DDS::mark_all | ( | bool | state | ) | [inherited] |
void libdap::DDS::parse | ( | FILE * | in = stdin |
) | [inherited] |
in | Read the persistent DDS from this FILE*. |
InternalErr | Thrown if in is null | |
Error | Thrown if the parse fails. |
Definition at line 650 of file DDS.cc.
References DBG2, dds_buffer(), dds_delete_buffer(), dds_switch_to_buffer(), and ddsparse().
Here is the call graph for this function:
void libdap::DDS::parse | ( | int | fd | ) | [inherited] |
Definition at line 621 of file DDS.cc.
References libdap::DDS::parse().
Here is the call graph for this function:
void libdap::DDS::parse | ( | string | fname | ) | [inherited] |
Definition at line 600 of file DDS.cc.
References cannot_read_file.
Referenced by libdap::DDS::parse(), libdap::DODSFilter::read_ancillary_dds(), libdap::Connect::request_dds(), libdap::Connect::request_dds_url(), libdap::Connect::request_ddx(), and libdap::Connect::request_ddx_url().
void libdap::DDS::print | ( | ostream & | out | ) | [inherited] |
Definition at line 692 of file DDS.cc.
References libdap::id2www().
Here is the call graph for this function:
void libdap::DDS::print | ( | FILE * | out | ) | [inherited] |
Definition at line 677 of file DDS.cc.
References libdap::id2www().
Referenced by main(), and libdap::DODSFilter::send_dds().
Here is the call graph for this function:
void libdap::DDS::print_constrained | ( | ostream & | out | ) | [inherited] |
Print those parts (variables) of the DDS structure to OS that are marked to be sent after evaluating the constraint expression.
Definition at line 743 of file DDS.cc.
References libdap::id2www().
Here is the call graph for this function:
void libdap::DDS::print_constrained | ( | FILE * | out | ) | [inherited] |
Print those parts (variables) of the DDS structure to OS that are marked to be sent after evaluating the constraint expression.
Definition at line 716 of file DDS.cc.
References libdap::id2www().
Referenced by libdap::DODSFilter::dataset_constraint(), and libdap::DODSFilter::send_dds().
Here is the call graph for this function:
void libdap::DDS::print_xml | ( | ostream & | out, | |
bool | constrained, | |||
const string & | blob | |||
) | [inherited] |
Print an XML represnetation 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.
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. |
Definition at line 833 of file DDS.cc.
References default_schema_location, dods_namespace, libdap::id2xml(), libdap::AttrTable::print_xml(), libdap::DDS::var_begin(), and libdap::DDS::var_end().
Here is the call graph for this function:
void libdap::DDS::print_xml | ( | FILE * | out, | |
bool | constrained, | |||
const string & | blob | |||
) | [inherited] |
Print an XML represnetation 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.
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. |
Definition at line 784 of file DDS.cc.
References default_schema_location, dods_namespace, libdap::id2xml(), libdap::AttrTable::print_xml(), libdap::DDS::var_begin(), and libdap::DDS::var_end().
Referenced by main(), and libdap::DODSFilter::send_ddx().
Here is the call graph for this function:
void libdap::DDS::set_dataset_name | ( | const string & | n | ) | [inherited] |
Sets the dataset name.
Definition at line 308 of file DDS.cc.
Referenced by libdap::DDXParser::ddx_start_element().
BaseTypeFactory* libdap::DDS::set_factory | ( | BaseTypeFactory * | factory | ) | [inline, inherited] |
void libdap::DataDDS::set_protocol | ( | const string & | p | ) | [inline] |
void libdap::DDS::set_timeout | ( | int | t | ) | [inherited] |
void libdap::DataDDS::set_version | ( | const string & | v | ) | [inline] |
void libdap::DDS::tag_nested_sequences | ( | ) | [inherited] |
Definition at line 588 of file DDS.cc.
References libdap::dods_sequence_c, and libdap::dods_structure_c.
Referenced by libdap::DODSFilter::send_data().
void libdap::DDS::timeout_off | ( | ) | [inherited] |
Definition at line 565 of file DDS.cc.
Referenced by libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::Sequence::read_row(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Structure::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
void libdap::DDS::timeout_on | ( | ) | [inherited] |
Definition at line 557 of file DDS.cc.
Referenced by libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::Sequence::read_row(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Structure::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
void libdap::DDS::transfer_attributes | ( | DAS * | das | ) | [virtual, inherited] |
Given a DAS object, scavenge attributes from it and load them into this object and the variables it contains.
If a DAS contans attributes from the current (8/2006) HDF4 server with names like var_dim_0, var_dim_1, then make those attribute tables sub tables of the var table.
das | Get attribute information from this DAS. |
Definition at line 246 of file DDS.cc.
References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), libdap::AttrTable::entry::attributes, DBG, libdap::DDS::find_matching_container(), libdap::AttrTable::get_attr_vector(), libdap::AttrTable::get_name(), libdap::AttrTable::get_type(), and libdap::BaseType::is_constructor_type().
Referenced by main().
Here is the call graph for this function:
BaseType * libdap::DDS::var | ( | const string & | n, | |
BaseType::btp_stack * | s = 0 | |||
) | [inherited] |
Returns a pointer to the named variable. If the name contains one or more field separators then the function looks for a variable whose name matches exactly. If the name contains no field separators then the funciton 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.
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. |
Definition at line 445 of file DDS.cc.
References libdap::DDS::exact_match(), libdap::DDS::leaf_match(), and libdap::www2id().
Here is the call graph for this function:
BaseType * libdap::DDS::var | ( | const string & | n, | |
BaseType::btp_stack & | s | |||
) | [inherited] |
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.
Definition at line 421 of file DDS.cc.
Referenced by libdap::DDS::exact_match(), libdap::DDS::find_matching_container(), and libdap::DDS::mark().
DDS::Vars_iter libdap::DDS::var_begin | ( | ) | [inherited] |
Definition at line 508 of file DDS.cc.
Referenced by libdap::DODSFilter::dataset_constraint(), libdap::DDS::duplicate(), and libdap::DDS::print_xml().
DDS::Vars_iter libdap::DDS::var_end | ( | ) | [inherited] |
Definition at line 520 of file DDS.cc.
Referenced by libdap::DODSFilter::dataset_constraint(), libdap::DDS::duplicate(), and libdap::DDS::print_xml().
DDS::Vars_riter libdap::DDS::var_rbegin | ( | ) | [inherited] |
DDS::Vars_riter libdap::DDS::var_rend | ( | ) | [inherited] |