#include <Structure.h>
Inheritance diagram for libdap::Structure:
Public Types | |
typedef stack< BaseType * > | btp_stack |
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 | |
virtual void | add_var (BaseType *bt, Part part=nil) |
virtual unsigned int | buf2val (void **val) |
Never call this. | |
virtual bool | check_semantics (string &msg, bool all=false) |
Compare an object's current state with the semantics of its type. | |
virtual bool | deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) |
Receive data from the net. | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual int | element_count (bool leaves=false) |
Count the members of constructor types. | |
virtual AttrTable & | get_attr_table () |
virtual BaseType * | get_parent () |
BaseType * | get_var_index (int i) |
Vars_iter | get_vars_iter (int i) |
virtual void | intern_data (const string &dataset, ConstraintEvaluator &eval, DDS &dds) |
virtual bool | is_constructor_type () |
Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. | |
virtual bool | is_in_selection () |
Is this variable part of the current selection? | |
virtual bool | is_linear () |
Check to see whether this variable can be printed simply. | |
virtual bool | is_simple_type () |
Returns true if the instance is a numeric, string or URL type variable. | |
virtual bool | is_vector_type () |
Returns true if the instance is a vector (i.e., array) type variable. | |
string | name () const |
Returns the name of the class instance. | |
Structure & | operator= (const Structure &rhs) |
virtual bool | ops (BaseType *b, int op, const string &dataset) |
Evaluate relational operators. | |
virtual void | print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) |
Print an ASCII representation of the variable structure. | |
virtual void | print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) |
Print an ASCII representation of the variable structure. | |
virtual void | print_val (ostream &out, string space="", bool print_decl_p=true) |
Prints the value of the variable. | |
virtual void | print_val (FILE *out, string space="", bool print_decl_p=true) |
Prints the value of the variable. | |
virtual void | print_xml (ostream &out, string space=" ", bool constrained=false) |
virtual void | print_xml (FILE *out, string space=" ", bool constrained=false) |
virtual BaseType * | ptr_duplicate () |
virtual bool | read (const string &dataset) |
simple implementation of reat that iterates through vars and calls read on them | |
virtual bool | read_p () |
Has this variable been read? | |
virtual bool | send_p () |
Should this variable be sent? | |
virtual bool | serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) |
Move data to the net. | |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
Set the in_selection property. | |
virtual void | set_leaf_sequence (int level=1) |
Traverse Structure, set Sequence leaf nodes. | |
virtual void | set_name (const string &n) |
Sets the name of the class instance. | |
virtual void | set_parent (BaseType *parent) |
virtual void | set_read_p (bool state) |
Sets the value of the read_p property. | |
virtual void | set_send_p (bool state) |
virtual void | set_synthesized_p (bool state) |
void | set_type (const Type &t) |
Sets the type of the class instance. | |
Structure (const Structure &rhs) | |
Structure (const string &n="") | |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable::entry *entry) |
Type | type () const |
Returns the type of the class instance. | |
string | type_name () const |
Returns the type of the class instance as a string. | |
virtual unsigned int | val2buf (void *val, bool reuse=false) |
Never call this. | |
virtual BaseType * | var (const string &name, btp_stack &s) |
virtual BaseType * | var (const string &name="", bool exact_match=true, btp_stack *s=0) |
Returns a pointer to a member of a constructor class. | |
virtual BaseType * | var (const string &n, btp_stack &s) |
virtual BaseType * | var (const string &name, bool exact_match=true, btp_stack *s=0) |
Vars_iter | var_begin () |
Vars_iter | var_end () |
Vars_riter | var_rbegin () |
Vars_riter | var_rend () |
virtual unsigned int | width () |
Returns the size of the class instance data. | |
virtual | ~Structure () |
Protected Member Functions | |
void | _duplicate (const BaseType &bt) |
Perform a deep copy. | |
void | _duplicate (const Constructor &s) |
void | _duplicate (const Structure &s) |
virtual AttrTable * | find_matching_container (AttrTable::entry *source, BaseType **dest_variable) |
Protected Attributes | |
std::vector< BaseType * > | _vars |
The DAP2 structure is defined as a singly-linked list. This means that Structure elements can be accessed either by name, with the var()
function, or by their position in the list, either with the overloaded version of var()
, or the combination of the first_var()
and next_var()
functions.
The val2buf()
and buf2val()
functions only return the size of the structure. To read parts of a DAP2 Structure into an application program, use the buf2val()
function of the element of the Structure in question.
Note that the predicate-setting functions set_send_p()
and set_read_p()
set their flags for the Structure as well as for each of the Structure's member elements.
Similar to C, you can refer to members of Structure elements with a ``.'' notation. For example, if the Structure has a member Structure called ``Tom'' and Tom has a member Float32 called ``shoe_size'', then you can refer to Tom's shoe size as ``Tom.shoe_size''.
Definition at line 102 of file Structure.h.
typedef stack<BaseType *> libdap::BaseType::btp_stack [inherited] |
Definition at line 211 of file BaseType.h.
typedef std::vector<BaseType *>::const_iterator libdap::Constructor::Vars_citer [inherited] |
Definition at line 54 of file Constructor.h.
typedef std::vector<BaseType *>::iterator libdap::Constructor::Vars_iter [inherited] |
Definition at line 55 of file Constructor.h.
typedef std::vector<BaseType *>::reverse_iterator libdap::Constructor::Vars_riter [inherited] |
Definition at line 56 of file Constructor.h.
libdap::Structure::Structure | ( | const string & | n = "" |
) |
The Structure constructor requires only the name of the variable to be created. The name may be omitted, which will create a nameless variable. This may be adequate for some applications.
n | A string containing the name of the variable to be created. |
Definition at line 77 of file Structure.cc.
Referenced by ptr_duplicate().
libdap::Structure::Structure | ( | const Structure & | rhs | ) |
The Structure copy constructor.
Definition at line 81 of file Structure.cc.
References _duplicate().
Here is the call graph for this function:
libdap::Structure::~Structure | ( | ) | [virtual] |
void libdap::BaseType::_duplicate | ( | const BaseType & | bt | ) | [protected, inherited] |
Perform a deep copy. Copies the values of bt into *this
. Pointers are dereferenced and their values are copied into a newly allocated instance.
bt | The source object. |
Definition at line 66 of file BaseType.cc.
References libdap::BaseType::_name, libdap::BaseType::_read_p, libdap::BaseType::_send_p, libdap::BaseType::_synthesized_p, libdap::BaseType::_type, libdap::BaseType::d_attr, libdap::BaseType::d_in_selection, and libdap::BaseType::d_parent.
Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().
void libdap::Constructor::_duplicate | ( | const Constructor & | s | ) | [protected, inherited] |
void libdap::Structure::_duplicate | ( | const Structure & | s | ) | [protected] |
Definition at line 51 of file Structure.cc.
References libdap::Constructor::_vars, DBG, libdap::BaseType::name(), and libdap::BaseType::set_parent().
Referenced by operator=(), and Structure().
Here is the call graph for this function:
Adds an element to a Structure.
bt | A pointer to the DAP2 type variable to add to this Structure. | |
part | Not used by this class, defaults to nil |
Reimplemented from libdap::BaseType.
Definition at line 193 of file Structure.cc.
References libdap::Constructor::_vars, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().
Here is the call graph for this function:
unsigned int libdap::Structure::buf2val | ( | void ** | val | ) | [virtual] |
Implements libdap::BaseType.
Definition at line 313 of file Structure.cc.
bool libdap::Structure::check_semantics | ( | string & | msg, | |
bool | all = false | |||
) | [virtual] |
This function checks the class instance for internal consistency. This is important to check for complex constructor classes. For BaseType, an object is semantically correct if it has both a non-null name and type.
For example, an Int32 instance would return FALSE if it had no name or no type defined. A Grid instance might return FALSE for more complex reasons, such as having Map arrays of the wrong size or shape.
This function is used by the DDS class, and will rarely, if ever, be explicitly called by a DODS application program. A variable must pass this test before it is sent, but there may be many other stages in a retrieve operation where it would fail.
msg | A returned string, containing a message indicating the source of any problem. | |
all | For complex constructor types (Grid, Sequence, Structure), this flag indicates whether to check the semantics of the member variables, too. |
Reimplemented from libdap::BaseType.
Definition at line 450 of file Structure.cc.
References libdap::Constructor::_vars, libdap::BaseType::check_semantics(), libdap::BaseType::name(), libdap::BaseType::type_name(), and libdap::unique_names().
Here is the call graph for this function:
bool libdap::Structure::deserialize | ( | UnMarshaller & | um, | |
DDS * | dds, | |||
bool | reuse = false | |||
) | [virtual] |
Receives data from the network connection identified by the source
parameter. The data is put into the class data buffer according to the input dds
.
This function is only used on the client side of the DODS client/server connection.
um | An UnMarshaller that knows how to deserialize data types | |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. This would have been received from the server in an earlier transmission. | |
reuse | A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is not reallocated. If FALSE, new storage is allocated. If the internal buffer has not been allocated at all, this argument has no effect. |
Error | when a problem reading from the UnMarshaller is found. |
Implements libdap::BaseType.
Definition at line 285 of file Structure.cc.
References libdap::Constructor::_vars.
void libdap::Structure::dump | ( | ostream & | strm | ) | const [virtual] |
Displays the pointer value of this instance and information about this instance.
strm | C++ i/o stream to dump the information to |
Reimplemented from libdap::Constructor.
Definition at line 483 of file Structure.cc.
References libdap::Constructor::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().
Here is the call graph for this function:
int libdap::Structure::element_count | ( | bool | leaves = false |
) | [virtual] |
Return a count of the total number of variables in this variable. This is used to count the number of variables held by a constructor variable - for simple type and vector variables it always returns 1.
For compound data types, there are two ways to count members. You can count the members, or you can count the simple members and add that to the count of the compound members. For example, if a Structure contains an Int32 and another Structure that itself contains two Int32 members, the element count of the top-level structure could be two (one Int32 and one Structure) or three (one Int32 by itself and two Int32's in the subsidiary Structure). Use the leaves parameter to control which kind of counting you desire.
leaves | This parameter is only relevant if the object contains other compound data types. If FALSE, the function counts only the data variables mentioned in the object's declaration. If TRUE, it counts the simple members, and adds that to the sum of the counts for the compound members. This parameter has no effect for simple type variables. |
Reimplemented from libdap::BaseType.
Definition at line 114 of file Structure.cc.
References libdap::Constructor::_vars.
AttrTable * libdap::Constructor::find_matching_container | ( | AttrTable::entry * | source, | |
BaseType ** | dest_variable | |||
) | [protected, virtual, inherited] |
Given an attribute container from a table, find or make a destination for its contents in the current constructor variable.
Definition at line 132 of file Constructor.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::BaseType::var().
Referenced by libdap::Constructor::transfer_attributes().
Here is the call graph for this function:
AttrTable & libdap::BaseType::get_attr_table | ( | ) | [virtual, inherited] |
Get this variable's AttrTable. It's generally a bad idea to return a reference to a contained object, but in this case it seems that building an interface inside BaseType is overkill.
Use the AttrTable methods to manipulate the table.
Definition at line 480 of file BaseType.cc.
Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::Array::print_xml_core().
BaseType * libdap::BaseType::get_parent | ( | ) | [virtual, inherited] |
Return a pointer to the Constructor or Vector which holds (contains) this variable. If this variable is at the top level, this method returns null.
Definition at line 550 of file BaseType.cc.
Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::function_linear_scale(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_two().
BaseType * libdap::Constructor::get_var_index | ( | int | i | ) | [inherited] |
Return the BaseType pointer for the ith variable.
i | This index |
Definition at line 270 of file Constructor.cc.
References libdap::Constructor::_vars.
Constructor::Vars_iter libdap::Constructor::get_vars_iter | ( | int | i | ) | [inherited] |
Return the iterator for the ith variable.
i | the index |
Definition at line 261 of file Constructor.cc.
References libdap::Constructor::_vars.
void libdap::Structure::intern_data | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds | |||
) | [virtual] |
Similar to using serialize() and deserialize() together in one object. Data are read as for serialize and those values are stored in the objects as deserialize() does but does not write and then read data to/from a stream.
This method is defined by the various data type classes. It calls the read() abstract method.
dataset | The (local) name of dataset to be read. | |
eval | Use this as the constraint expression evaluator. | |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. |
Reimplemented from libdap::BaseType.
Definition at line 247 of file Structure.cc.
References libdap::Constructor::_vars, read(), and libdap::BaseType::read_p().
Here is the call graph for this function:
bool libdap::BaseType::is_constructor_type | ( | ) | [virtual, inherited] |
Definition at line 306 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::DDXParser::ddx_end_element(), libdap::DDS::transfer_attributes(), libdap::Constructor::transfer_attributes(), and libdap::Vector::var().
Here is the call graph for this function:
bool libdap::BaseType::is_in_selection | ( | ) | [virtual, inherited] |
Does this variable appear in either the selection part or as a function argument in the current constrain expression. If this property is set (true) then implementations of the read() method should read this variable.
Definition at line 505 of file BaseType.cc.
bool libdap::Structure::is_linear | ( | ) | [virtual] |
True if the instance can be flattened and printed as a single table of values. For Arrays and Grids this is always false. For Structures and Sequences the conditions are more complex. The implementation provided by this class always returns false. Other classes should override this implementation.
Reimplemented from libdap::Constructor.
Definition at line 128 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::dods_structure_c.
bool libdap::BaseType::is_simple_type | ( | ) | [virtual, inherited] |
Definition at line 245 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().
Here is the call graph for this function:
bool libdap::BaseType::is_vector_type | ( | ) | [virtual, inherited] |
Definition at line 274 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::DDXParser::ddx_end_element().
Here is the call graph for this function:
string libdap::BaseType::name | ( | ) | const [inherited] |
Definition at line 173 of file BaseType.cc.
Referenced by _duplicate(), libdap::Vector::add_var(), check_semantics(), libdap::Sequence::check_semantics(), libdap::Grid::check_semantics(), libdap::Sequence::deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), libdap::GSEClause::get_map_name(), libdap::GridGeoConstraint::GridGeoConstraint(), libdap::GSEClause::GSEClause(), libdap::Sequence::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::intern_data_private(), libdap::DDS::mark(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::Array::print_xml_core(), libdap::Sequence::read_row(), libdap::Sequence::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), libdap::Sequence::set_leaf_sequence(), libdap::BaseType::set_name(), libdap::BaseType::set_read_p(), libdap::Constructor::transfer_attributes(), libdap::rvalue::value_name(), libdap::Vector::var(), var(), libdap::Sequence::var(), and libdap::Grid::var().
Definition at line 101 of file Structure.cc.
References _duplicate().
Here is the call graph for this function:
bool libdap::BaseType::ops | ( | BaseType * | b, | |
int | op, | |||
const string & | dataset | |||
) | [virtual, inherited] |
This method contains the relational operators used by the constraint expression evaluator in the DDS class. Each class that wants to be able to evaluate relational expressions must overload this function. The implementation in BaseType throws an InternalErr exception. The DAP library classes Byte, ..., Url provide specializations of this method. It is not meaningful for classes such as Array because relational expressions using Array are not supported.
The op argument refers to a table generated by bison from the constraint expression parser. Use statements like the following to correctly interpret its value:
switch (op) { case EQUAL: return i1 == i2; case NOT_EQUAL: return i1 != i2; case GREATER: return i1 > i2; case GREATER_EQL: return i1 >= i2; case LESS: return i1 < i2; case LESS_EQL: return i1 <= i2; case REGEXP: throw Error("Regular expressions are not supported for integer values"); default: throw Error("Unknown operator"); }
This function is used by the constraint expression evaluator.
b | Compare the value of this instance with b. | |
op | An integer index indicating which relational operator is implied. Choose one from the following: EQUAL , NOT_EQUAL , GREATER , GREATER_EQL , LESS , LESS_EQL , and REGEXP . | |
dataset | The name of the dataset from which the instance's data has come (or is to come). |
Reimplemented in libdap::Byte, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Str, libdap::UInt16, and libdap::UInt32.
Definition at line 979 of file BaseType.cc.
Referenced by libdap::Clause::value().
void libdap::Constructor::print_decl | ( | ostream & | out, | |
string | space = " " , |
|||
bool | print_semi = true , |
|||
bool | constraint_info = false , |
|||
bool | constrained = false | |||
) | [virtual, inherited] |
Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.
A simple array declaration might look like this:
Float64 lat[lat = 180];
Grid { ARRAY: Int32 sst[time = 404][lat = 180][lon = 360]; MAPS: Float64 time[time = 404]; Float64 lat[lat = 180]; Float64 lon[lon = 360]; } sst;
out | The output stream on which to print the declaration. | |
space | Each line of the declaration will begin with the characters in this string. Usually used for leading spaces. | |
print_semi | A boolean value indicating whether to print a semicolon at the end of the declaration. | |
constraint_info | A boolean value indicating whether constraint information is to be printed with the declaration. If the value of this parameter is TRUE, print_decl() prints the value of the variable's send_p() flag after the declaration. | |
constrained | If this boolean value is TRUE, the variable's declaration is only printed if is the send_p() flag is TRUE. If a constraint expression is in place, and this variable is not requested, the send_p() flag is FALSE. |
DDS::CE
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 302 of file Constructor.cc.
References libdap::Constructor::_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().
Here is the call graph for this function:
void libdap::Constructor::print_decl | ( | FILE * | out, | |
string | space = " " , |
|||
bool | print_semi = true , |
|||
bool | constraint_info = false , |
|||
bool | constrained = false | |||
) | [virtual, inherited] |
Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.
A simple array declaration might look like this:
Float64 lat[lat = 180];
Grid { ARRAY: Int32 sst[time = 404][lat = 180][lon = 360]; MAPS: Float64 time[time = 404]; Float64 lat[lat = 180]; Float64 lon[lon = 360]; } sst;
out | The output stream on which to print the declaration. | |
space | Each line of the declaration will begin with the characters in this string. Usually used for leading spaces. | |
print_semi | A boolean value indicating whether to print a semicolon at the end of the declaration. | |
constraint_info | A boolean value indicating whether constraint information is to be printed with the declaration. If the value of this parameter is TRUE, print_decl() prints the value of the variable's send_p() flag after the declaration. | |
constrained | If this boolean value is TRUE, the variable's declaration is only printed if is the send_p() flag is TRUE. If a constraint expression is in place, and this variable is not requested, the send_p() flag is FALSE. |
DDS::CE
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 277 of file Constructor.cc.
References libdap::Constructor::_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().
Referenced by print_val(), and libdap::Sequence::print_val_by_rows().
Here is the call graph for this function:
void libdap::Structure::print_val | ( | ostream & | out, | |
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual] |
Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.
out | The output ostream on which to print the value. | |
space | This value is passed to the print_decl() function, and controls the leading spaces of the output. | |
print_decl_p | A boolean value controlling whether the variable declaration is printed as well as the value. |
Implements libdap::BaseType.
Definition at line 430 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::Constructor::print_decl().
Here is the call graph for this function:
void libdap::Structure::print_val | ( | FILE * | out, | |
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual] |
Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.
out | The output FILE on which to print the value. | |
space | This value is passed to the print_decl() function, and controls the leading spaces of the output. | |
print_decl_p | A boolean value controlling whether the variable declaration is printed as well as the value. |
Implements libdap::BaseType.
Definition at line 410 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::Constructor::print_decl().
Here is the call graph for this function:
void libdap::Constructor::print_xml | ( | ostream & | out, | |
string | space = " " , |
|||
bool | constrained = false | |||
) | [virtual, inherited] |
Write the XML representation of this variable. This method is used to build the DDX XML response.
out | Destination output stream | |
space | Use this to indent child declarations. Default is "". | |
constrained | If true, only print this if it's part part of the current projection. Default is False. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 387 of file Constructor.cc.
References libdap::BaseType::get_attr_table(), libdap::id2xml(), libdap::BaseType::name(), libdap::AttrTable::print_xml(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Here is the call graph for this function:
void libdap::Constructor::print_xml | ( | FILE * | out, | |
string | space = " " , |
|||
bool | constrained = false | |||
) | [virtual, inherited] |
Write the XML representation of this variable. This method is used to build the DDX XML response.
out | Destination. | |
space | Use this to indent child declarations. Default is "". | |
constrained | If true, only print this if it's part part of the current projection. Default is False. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 343 of file Constructor.cc.
References libdap::BaseType::get_attr_table(), libdap::id2xml(), libdap::BaseType::name(), libdap::AttrTable::print_xml(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Here is the call graph for this function:
BaseType * libdap::Structure::ptr_duplicate | ( | ) | [virtual] |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
this
. Implements libdap::BaseType.
Definition at line 95 of file Structure.cc.
References Structure().
Here is the call graph for this function:
bool libdap::Structure::read | ( | const string & | dataset | ) | [virtual] |
dataset | A string naming the dataset from which the data is to be read. The meaning of this string will vary among different types of data sources. It may be the name of a data file or an identifier used to read data from a relational database. |
Reimplemented from libdap::BaseType.
Definition at line 221 of file Structure.cc.
References libdap::Constructor::_vars, libdap::BaseType::read_p(), and set_read_p().
Referenced by intern_data(), and serialize().
Here is the call graph for this function:
bool libdap::BaseType::read_p | ( | ) | [virtual, inherited] |
Returns true if the value(s) for this variable have been read from the data source, otherwise returns false. This method is used to determine when values need to be read using the read() method. When read_p() returns true, this library assumes that buf2val() (and other methods such as get_vec()) can be used to access the value(s) of a variable.
Definition at line 394 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::Vector::intern_data(), intern_data(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), read(), libdap::Sequence::read_row(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
bool libdap::BaseType::send_p | ( | ) | [virtual, inherited] |
Returns the state of the send_p
property. If true, this variable should be sent to the client, if false, it should not. If no constraint expression (CE) has been evaluated, this property is true for all variables in a data source (i.e., for all the variables listed in a DDS). If a CE has been evaluated, this property is true only for those variables listed in the projection part of the CE.
Definition at line 452 of file BaseType.cc.
Referenced by libdap::Grid::components(), libdap::Grid::intern_data(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::BaseType::print_decl(), libdap::Array::print_decl(), libdap::Grid::print_val(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), libdap::Grid::projection_yields_grid(), and libdap::Grid::serialize().
bool libdap::Structure::serialize | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds, | |||
Marshaller & | m, | |||
bool | ce_eval = true | |||
) | [virtual] |
Sends the data from the indicated (local) dataset through the connection identified by the sink parameter. If the data is not already incorporated into the DDS object, read the data from the dataset.
This function is only used on the server side of the client/server connection, and is generally only called from the DODSFilter::send() function. It has no BaseType implementation; each datatype child class supplies its own implementation.
dataset | The (local) name of dataset to be read. | |
eval | Use this as the constraint expression evaluator. | |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. | |
m | A marshaller used to serialize data types | |
ce_eval | A boolean value indicating whether to evaluate the DODS constraint expression that may accompany this dataset. The constraint expression is stored in dds. |
InternalErr. | ||
Error. |
Implements libdap::BaseType.
Definition at line 260 of file Structure.cc.
References libdap::Constructor::_vars, libdap::ConstraintEvaluator::eval_selection(), read(), libdap::BaseType::read_p(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().
Here is the call graph for this function:
void libdap::BaseType::set_attr_table | ( | const AttrTable & | at | ) | [virtual, inherited] |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 488 of file BaseType.cc.
void libdap::Structure::set_in_selection | ( | bool | state | ) | [virtual] |
Set the in_selection property for this variable and all of its children.
state | Set the property value to state. |
Reimplemented from libdap::BaseType.
Definition at line 167 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::BaseType::set_in_selection().
Here is the call graph for this function:
void libdap::Structure::set_leaf_sequence | ( | int | level = 1 |
) | [virtual] |
Definition at line 178 of file Structure.cc.
References libdap::dods_sequence_c, libdap::dods_structure_c, libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Here is the call graph for this function:
void libdap::BaseType::set_name | ( | const string & | n | ) | [virtual, inherited] |
Definition at line 180 of file BaseType.cc.
References libdap::BaseType::name(), and libdap::www2id().
Referenced by libdap::Vector::add_var(), and libdap::Array::print_xml_core().
Here is the call graph for this function:
void libdap::BaseType::set_parent | ( | BaseType * | parent | ) | [virtual, inherited] |
Set the parent
property for this variable. Only instances of Constructor or Vector should call this method.
parent | Pointer to the Constructor of Vector parent variable. |
InternalErr | thrown if called with anything other than a Constructor or Vector. |
Definition at line 533 of file BaseType.cc.
Referenced by libdap::Vector::_duplicate(), _duplicate(), libdap::Vector::add_var(), add_var(), libdap::Sequence::add_var(), libdap::Grid::add_var(), and libdap::Vector::Vector().
void libdap::Structure::set_read_p | ( | bool | state | ) | [virtual] |
Sets the value of the read_p
property. This indicates that the value(s) of this variable has/have been read. An implementation of the read() method would typically use this to set the read_p
property to true.
For synthesized variables, this method does nothing. Thus, if a synthesized variable is added to a Sequence, the Sequence can iteratively reset the read_p property without affecting the value of that property for the synthesized variable. That's important since a synthesized variable's value is calculated, not read.
state | Set the read_p property to this state. |
Reimplemented from libdap::BaseType.
Definition at line 152 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::BaseType::set_read_p().
Referenced by read().
Here is the call graph for this function:
void libdap::Structure::set_send_p | ( | bool | state | ) | [virtual] |
Sets the value of the send_p
flag. This function is meant to be called from within the constraint evaluator of other code which determines that this variable should be returned to the client. Data are ready to be sent when both the _send_p
and _read_p
flags are set to TRUE.
state | The logical state to set the send_p flag. |
Reimplemented from libdap::BaseType.
Definition at line 142 of file Structure.cc.
References libdap::Constructor::_vars, and libdap::BaseType::set_send_p().
Here is the call graph for this function:
void libdap::BaseType::set_synthesized_p | ( | bool | state | ) | [virtual, inherited] |
Set the synthesized flag. Before setting this flag be sure to set the read_p()
state. Once this flag is set you cannot alter the state of the read_p
flag!
Definition at line 377 of file BaseType.cc.
void libdap::BaseType::set_type | ( | const Type & | t | ) | [inherited] |
bool libdap::BaseType::synthesized_p | ( | ) | [virtual, inherited] |
Returns true if the variable is a synthesized variable. A synthesized variable is one that is added to the dataset by the server (usually with a `projection function'.
Definition at line 366 of file BaseType.cc.
string libdap::BaseType::toString | ( | ) | [virtual, inherited] |
Write out the object's internal fields in a string. To be used for debugging when regular inspection w/ddd or gdb isn't enough.
Reimplemented in libdap::Sequence.
Definition at line 126 of file BaseType.cc.
References libdap::BaseType::type_name().
Referenced by libdap::GSEClause::GSEClause(), and libdap::Sequence::toString().
Here is the call graph for this function:
void libdap::Constructor::transfer_attributes | ( | AttrTable::entry * | entry | ) | [virtual, inherited] |
Given an Attribute entry, scavenge attributes from it and load them into this object and the variables it contains. Assume that the caller has determined the table holds attributes pertinent to only this variable.
entry | Get attribute information from this Attribute table. Note that even though the type of the argument is an AttrTable::entry, the entry must be an attribute container. |
Definition at line 195 of file Constructor.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::Constructor::find_matching_container(), libdap::AttrTable::get_attr_vector(), libdap::AttrTable::get_name(), libdap::AttrTable::get_type(), libdap::BaseType::is_constructor_type(), libdap::BaseType::name(), and libdap::AttrTable::entry::type.
Here is the call graph for this function:
Type libdap::BaseType::type | ( | ) | const [inherited] |
Definition at line 188 of file BaseType.cc.
Referenced by libdap::Array::add_var(), libdap::Vector::buf2val(), libdap::Grid::check_semantics(), libdap::Vector::deserialize(), libdap::Vector::dump(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::function_linear_scale(), libdap::XDRFileUnMarshaller::get_vector(), libdap::Vector::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::BaseType::is_constructor_type(), libdap::BaseType::is_simple_type(), libdap::BaseType::is_vector_type(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), libdap::Sequence::print_one_row(), libdap::XDRStreamMarshaller::put_vector(), libdap::XDRFileMarshaller::put_vector(), libdap::Vector::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_two(), libdap::set_array_using_double(), libdap::Vector::set_value(), libdap::Vector::set_vec(), libdap::Vector::val2buf(), libdap::Vector::value(), and libdap::Vector::var().
string libdap::BaseType::type_name | ( | ) | const [inherited] |
Definition at line 202 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, and libdap::dods_url_c.
Referenced by libdap::Vector::add_var(), check_semantics(), libdap::Sequence::check_semantics(), libdap::Grid::check_semantics(), libdap::Vector::deserialize(), libdap::BaseType::dump(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::BaseType::print_decl(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::BaseType::toString().
unsigned int libdap::Structure::val2buf | ( | void * | val, | |
bool | reuse = false | |||
) | [virtual] |
This method cannot be used to change values of a Structure since the values of a Constructor type must be set using methods in Constructor. See the Constructor::var_begin() and related methods.
Implements libdap::BaseType.
Definition at line 304 of file Structure.cc.
This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as BaseType::var(const string &, bool, btp_stack *) when exact_match is false. In addition to returning a pointer to the variable, it pushes onto s a BaseType pointer to each constructor type that ultimately contains name.
Definition at line 579 of file BaseType.cc.
BaseType * libdap::BaseType::var | ( | const string & | name = "" , |
|
bool | exact_match = true , |
|||
btp_stack * | s = 0 | |||
) | [virtual, inherited] |
Returns a pointer to the contained variable in a composite class. The composite classes are those made up of aggregated simple data types. Array, Grid, and Structure are composite types, while Int and Float are simple types. This function is only used by composite classes. The BaseType implementation always returns null.
Several of the subclasses provide alternate access methods that make sense for that particular data type. For example, the Array class defines a *var(int i)
method that returns the ith entry in the Array data, and the Structure provides a *var(Vars_iter)
function using a pseudo-index to access the different members of the structure.
name | The name of the class member. Defaults to "" | |
exact_match | True if only interested in variables whose full names match n exactly. If false, returns the first variable whose name matches name. For example, if name is x and point.x is a variable, then var("x", false) would return a BaseType pointer to point.x . If exact_match was true then name would need to be "point.x" for var to return that pointer. This feature simplifies constraint expressions for datasets which have complex, nested, constructor variables. Defaults to true. | |
s | Record the path to name. Defaults to null, in which case it is not used. |
Definition at line 557 of file BaseType.cc.
Referenced by libdap::DDS::exact_match(), libdap::Constructor::find_matching_container(), and libdap::Vector::var().
Definition at line 331 of file Structure.cc.
References libdap::BaseType::name(), and libdap::www2id().
Here is the call graph for this function:
BaseType * libdap::Structure::var | ( | const string & | name, | |
bool | exact_match = true , |
|||
btp_stack * | s = 0 | |||
) | [virtual] |
Definition at line 319 of file Structure.cc.
References libdap::www2id().
Here is the call graph for this function:
Constructor::Vars_iter libdap::Constructor::var_begin | ( | ) | [inherited] |
Returns an iterator referencing the first structure element.
Definition at line 87 of file Constructor.cc.
References libdap::Constructor::_vars.
Referenced by libdap::DDXParser::ddx_end_document(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Constructor::print_xml(), and set_leaf_sequence().
Constructor::Vars_iter libdap::Constructor::var_end | ( | ) | [inherited] |
Returns an iterator referencing the end of the list of structure elements. Does not reference the last structure element.
Definition at line 237 of file Constructor.cc.
References libdap::Constructor::_vars.
Referenced by libdap::DDXParser::ddx_end_document(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Constructor::print_xml(), and set_leaf_sequence().
Constructor::Vars_riter libdap::Constructor::var_rbegin | ( | ) | [inherited] |
Return a reverse iterator that references the last element.
Definition at line 244 of file Constructor.cc.
References libdap::Constructor::_vars.
Constructor::Vars_riter libdap::Constructor::var_rend | ( | ) | [inherited] |
Return a reverse iterator that references a point 'before' the first element.
Definition at line 252 of file Constructor.cc.
References libdap::Constructor::_vars.
unsigned int libdap::Structure::width | ( | ) | [virtual] |
Return the number of bytes that are required to hold the instance's value. In the case of simple types such as Int32, this is the size of one Int32 (four bytes). For a String or Url type, width()
returns the number of bytes needed for a String *
variable, not the bytes needed for all the characters, since that value cannot be determined from type information alone. For Structure, and other constructor types size() returns the number of bytes needed to store pointers to the C++ objects.
Implements libdap::BaseType.
Definition at line 235 of file Structure.cc.
References libdap::Constructor::_vars.
std::vector<BaseType *> libdap::Constructor::_vars [protected, inherited] |
Definition at line 47 of file Constructor.h.
Referenced by _duplicate(), add_var(), libdap::Sequence::add_var(), check_semantics(), libdap::Sequence::check_semantics(), deserialize(), libdap::Sequence::deserialize(), libdap::Constructor::dump(), element_count(), libdap::Sequence::element_count(), libdap::Constructor::get_var_index(), libdap::Constructor::get_vars_iter(), intern_data(), is_linear(), libdap::Sequence::is_linear(), libdap::Constructor::print_decl(), print_val(), read(), serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), set_in_selection(), libdap::Sequence::set_in_selection(), libdap::Sequence::set_leaf_sequence(), set_read_p(), libdap::Sequence::set_read_p(), set_send_p(), libdap::Sequence::set_send_p(), libdap::Sequence::toString(), libdap::Constructor::var_begin(), libdap::Constructor::var_end(), libdap::Constructor::var_rbegin(), libdap::Constructor::var_rend(), width(), libdap::Sequence::width(), libdap::Sequence::~Sequence(), and ~Structure().