libdap++ Updated for version 3.8.2
|
Holds the Grid data type. More...
#include <Grid.h>
Public Types | |
typedef stack< BaseType * > | btp_stack |
typedef std::vector< BaseType * > ::const_iterator | Map_citer |
typedef std::vector< BaseType * > ::iterator | Map_iter |
typedef std::vector< BaseType * > ::reverse_iterator | Map_riter |
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 Array * | add_map (Array *p_new_map, bool add_copy) |
virtual void | add_var (BaseType *bt, Part part) |
BaseType * | array_var () |
Returns the Grid Array. | |
virtual unsigned int | buf2val (void **val) |
virtual bool | check_semantics (string &msg, bool all=false) |
Return true if this Grid is well formed. | |
virtual void | clear_constraint () |
virtual int | components (bool constrained=false) |
Returns the number of components in the Grid object. | |
string | dataset () const |
Returns the name of the dataset used to create this instance. | |
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. | |
Array * | get_array () |
Returns the Grid Array. This method returns the array using an Array*, so no cast is required. | |
virtual AttrTable & | get_attr_table () |
Map_iter | get_map_iter (int i) |
virtual BaseType * | get_parent () |
BaseType * | get_var_index (int i) |
Vars_iter | get_vars_iter (int i) |
Grid (const string &n, const string &d) | |
The Grid constructor. | |
Grid (const string &n) | |
The Grid constructor. | |
Grid (const Grid &rhs) | |
The Grid copy constructor. | |
virtual void | intern_data (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. | |
Map_iter | map_begin () |
Returns an iterator referencing the first Map vector. | |
Map_iter | map_end () |
Map_riter | map_rbegin () |
Returns an iterator referencing the first Map vector. | |
Map_riter | map_rend () |
string | name () const |
Returns the name of the class instance. | |
Grid & | operator= (const Grid &rhs) |
virtual bool | ops (BaseType *b, int op) |
Evaluate relational operators. | |
virtual Array * | prepend_map (Array *p_new_map, bool add_copy) |
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_val (ostream &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 bool | projection_yields_grid () |
virtual BaseType * | ptr_duplicate () |
virtual bool | read () |
Read data into a local buffer. | |
virtual bool | read_p () |
Has this variable been read? | |
virtual bool | send_p () |
Should this variable be sent? | |
virtual bool | serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) |
Move data to the net. | |
virtual void | set_array (Array *p_new_arr) |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
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. | |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable *at_container) |
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 *buf, bool reuse=false) |
Returns the size of the Grid type. | |
virtual BaseType * | var (const string &n, btp_stack &s) |
virtual BaseType * | var (const string &n, bool exact=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 | ~Grid () |
Protected Member Functions | |
void | _duplicate (const Grid &s) |
void | _duplicate (const BaseType &bt) |
Perform a deep copy. | |
void | _duplicate (const Constructor &s) |
Protected Attributes | |
std::vector< BaseType * > | _vars |
The Grid data type is a collection of an Array and a set of ``Map'' vectors. The Map vectors are one-dimensional arrays corresponding to each dimension of the central Array. Using this scheme, a Grid can represent, in a rectilinear array, data which is not in reality rectilinear. An example will help make it clear.
Assume that the following array contains measurements of some real quantity, conducted at nine different points in space:
A = [ 1 2 3 4 ] [ 2 4 6 8 ] [ 3 6 9 12]
To locate this Array in the real world, we could note the location of one corner of the grid, and the grid spacing. This would allow us to calculate the location of any of the other points of the Array.
This approach will not work, however, unless the grid spacing is precisely regular. If the distance between Row 1 and Row 2 is not the same as the distance between Row 2 and Row 3, the scheme will break down. The solution is to equip the Array with two Map vectors that define the location of each row or column of the array:
A = [ 1 2 3 4 ] Row = [ 0 ] [ 2 4 6 8 ] [ 3 ] [ 3 6 9 12] [ 8 ]
Column = [ 0 2 8 27]
The real location of the point in the first row and column of the array is now exactly fixed at (0,0), and the point in the last row and last column is at (8,27).
The Grid data type has two parts: an Array, and a singly-linked list of Map vectors to describe the Array. The access functions for this class include a function to return the Array (get_array()
), and a set of functions for cycling through the list of Map vectors.
Move, in some sense, the _map_vars up to Constructor. Look at using Constructor's _var field for these.
Along the same lines as the previous item, consider removing the Part enum and adopting the convention that the first variable added is the array and any subsequent variables are maps.
typedef stack<BaseType *> libdap::BaseType::btp_stack [inherited] |
Definition at line 214 of file BaseType.h.
typedef std::vector<BaseType *>::const_iterator libdap::Grid::Map_citer |
typedef std::vector<BaseType *>::iterator libdap::Grid::Map_iter |
typedef std::vector<BaseType *>::reverse_iterator libdap::Grid::Map_riter |
typedef std::vector<BaseType *>::const_iterator libdap::Constructor::Vars_citer [inherited] |
Definition at line 60 of file Constructor.h.
typedef std::vector<BaseType *>::iterator libdap::Constructor::Vars_iter [inherited] |
Definition at line 61 of file Constructor.h.
typedef std::vector<BaseType *>::reverse_iterator libdap::Constructor::Vars_riter [inherited] |
Definition at line 62 of file Constructor.h.
libdap::Grid::Grid | ( | const string & | n | ) |
The Grid 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 86 of file Grid.cc.
Referenced by buf2val(), ptr_duplicate(), and val2buf().
libdap::Grid::Grid | ( | const string & | n, |
const string & | d | ||
) |
The Grid server-side constructor requires the name of the variable to be created and the dataset name from which this variable is created. Used when creating variables on the server side.
n | A string containing the name of the variable to be created. |
d | A string containing the name of the dataset from which this variable is being created. |
libdap::Grid::Grid | ( | const Grid & | rhs | ) |
Definition at line 105 of file Grid.cc.
References _duplicate().
void libdap::Grid::_duplicate | ( | const Grid & | s | ) | [protected] |
Definition at line 57 of file Grid.cc.
References libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().
Referenced by Grid(), and operator=().
void libdap::Constructor::_duplicate | ( | const Constructor & | s | ) | [protected, inherited] |
Definition at line 57 of file Constructor.cc.
Referenced by libdap::Constructor::operator=().
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 80 of file BaseType.cc.
References DBG.
Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().
Add the given array p_new_map as a new map vector for the Grid.
If add_as_copy, p_new_map will be cloned and the copy added, leaving p_new_map in the control of the caller.
If !add_as_copy, p_new_map will be explicitly added as the new map vector.
The actual Array* in the Grid will be returned, either the address of the COPY if add_as_copy, else p_new_map itself if !add_as_copy.
It is an exception for p_new_map to be null.
p_new_map | the map we want to add |
add_as_copy | whether to add p_new_map explicitly and take onwership of memory or to add a clone of it and leave control to caller. |
Definition at line 468 of file Grid.cc.
References libdap::Constructor::_vars, libdap::Array::ptr_duplicate(), and libdap::BaseType::set_parent().
Add an array or map to the Grid.
The original version of this method required that the part
parameter be present. However, this complicates using the class from a parser (e.g., the schema-based XML parser). I have modified the method so that if part
is nil (the default), then the first variable added is the array and subsequent variables are maps. This matches the behavior in the Java DAP implementation.
bt | Array or Map variable |
part | is this an array or a map. If not present, first bt is the array and subsequent bt s are maps. |
Reimplemented from libdap::BaseType.
Definition at line 346 of file Grid.cc.
References libdap::Constructor::_vars, libdap::array, libdap::maps, libdap::BaseType::ptr_duplicate(), libdap::Array::ptr_duplicate(), set_array(), and libdap::BaseType::set_parent().
BaseType * libdap::Grid::array_var | ( | ) |
unsigned int libdap::Grid::buf2val | ( | void ** | val | ) | [virtual] |
bool libdap::Grid::check_semantics | ( | string & | msg, |
bool | all = false |
||
) | [virtual] |
The array dimensions and number of map vectors must match and both the array and maps must be of simple-type elements.
Reimplemented from libdap::BaseType.
Definition at line 1022 of file Grid.cc.
References libdap::BaseType::check_semantics(), libdap::Array::dim_begin(), libdap::Array::dimension_size(), libdap::Array::dimensions(), libdap::dods_array_c, libdap::BaseType::is_simple_type(), libdap::BaseType::name(), libdap::BaseType::type(), and libdap::Vector::var().
void libdap::Grid::clear_constraint | ( | ) | [virtual] |
For each of the Array and Maps in this Grid, call clear_constraint().
Definition at line 710 of file Grid.cc.
References libdap::Array::clear_constraint(), map_begin(), and map_end().
int libdap::Grid::components | ( | bool | constrained = false | ) | [virtual] |
Returns the number of components in the Grid object. This is equal to one plus the number of Map vectors. If there is a constraint expression in effect, the number of dimensions needed may be smaller than the actual number in the stored data. (Or the Array might not even be requested.) In this case, a user can request the smaller number with the constrained flag.
constrained | If TRUE, the function returns the number of components contained in the constrained Grid. Since a constraint expression might well eliminate one or more of the Grid dimensions, this number can be lower than the actual number of components. If this parameter is FALSE (the default), the actual number of components will be returned. |
Definition at line 592 of file Grid.cc.
References libdap::BaseType::send_p().
Referenced by projection_yields_grid().
string libdap::BaseType::dataset | ( | ) | const [inherited] |
A 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.
Definition at line 231 of file BaseType.cc.
Referenced by 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(), serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
bool libdap::Grid::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 268 of file Grid.cc.
References libdap::BaseType::deserialize().
void libdap::Grid::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 1119 of file Grid.cc.
References libdap::BaseType::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().
int libdap::Grid::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 149 of file Grid.cc.
References libdap::Vector::element_count(), and get_array().
Array * libdap::Grid::get_array | ( | ) |
Definition at line 528 of file Grid.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), element_count(), libdap::function_geogrid(), libdap::function_grid(), libdap::GridGeoConstraint::GridGeoConstraint(), and print_xml().
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 531 of file BaseType.cc.
Referenced by print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), transfer_attributes(), libdap::Constructor::transfer_attributes(), and libdap::BaseType::transfer_attributes().
Grid::Map_iter libdap::Grid::get_map_iter | ( | int | i | ) |
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 655 of file BaseType.cc.
Referenced by 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 328 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 319 of file Constructor.cc.
References libdap::Constructor::_vars.
void libdap::Grid::intern_data | ( | 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.
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 216 of file Grid.cc.
References libdap::BaseType::intern_data(), libdap::BaseType::read(), libdap::BaseType::read_p(), libdap::BaseType::send_p(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().
bool libdap::BaseType::is_constructor_type | ( | ) | [virtual, inherited] |
Definition at line 356 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_sax2_end_element(), libdap::DDS::leaf_match(), and libdap::Vector::var().
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 610 of file BaseType.cc.
bool libdap::Constructor::is_linear | ( | ) | [virtual, inherited] |
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 in libdap::Sequence, and libdap::Structure.
Definition at line 488 of file Constructor.cc.
bool libdap::BaseType::is_simple_type | ( | ) | [virtual, inherited] |
Definition at line 295 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 check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().
bool libdap::BaseType::is_vector_type | ( | ) | [virtual, inherited] |
Definition at line 324 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_sax2_end_element(), and libdap::DDS::leaf_match().
Grid::Map_iter libdap::Grid::map_begin | ( | ) |
Definition at line 539 of file Grid.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), clear_constraint(), libdap::function_geogrid(), libdap::function_grid(), print_xml(), projection_yields_grid(), and transfer_attributes().
Grid::Map_iter libdap::Grid::map_end | ( | ) |
Returns an iterator referencing the end of the list of Map vectors. It does not reference the last Map vector
Definition at line 547 of file Grid.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), clear_constraint(), libdap::function_geogrid(), libdap::function_grid(), print_xml(), projection_yields_grid(), and transfer_attributes().
Grid::Map_riter libdap::Grid::map_rbegin | ( | ) |
Grid::Map_riter libdap::Grid::map_rend | ( | ) |
string libdap::BaseType::name | ( | ) | const [inherited] |
Definition at line 210 of file BaseType.cc.
Referenced by libdap::Structure::_duplicate(), libdap::Vector::add_var(), libdap::Structure::check_semantics(), libdap::Sequence::check_semantics(), 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::Vector::intern_data(), libdap::Structure::intern_data(), libdap::Sequence::intern_data(), libdap::BaseType::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::leaf_match(), libdap::DDS::mark(), print_decl(), libdap::Constructor::print_decl(), print_xml(), libdap::Constructor::print_xml(), libdap::Array::print_xml_core(), libdap::Sequence::read_row(), libdap::DODSFilter::send_data_ddx(), libdap::Str::serialize(), 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::BaseType::set_send_p(), transfer_attributes(), libdap::Constructor::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::rvalue::value_name(), libdap::Vector::var(), libdap::Structure::var(), libdap::Sequence::var(), var(), and libdap::Sequence::var_value().
Definition at line 127 of file Grid.cc.
References _duplicate().
bool libdap::BaseType::ops | ( | BaseType * | b, |
int | op | ||
) | [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 . |
Reimplemented in libdap::Byte, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Str, libdap::UInt16, and libdap::UInt32.
Definition at line 1081 of file BaseType.cc.
Referenced by libdap::Clause::value().
Add pMap (or a clone if addAsCopy) to the FRONT of the maps list. This is needed if we are preserving Grid semantics but want to add a new OUTER dimension, whereas add_map appends to the end making a new INNER dimension.
pMap | the map to add or copy and add |
add_copy | if true, copy pMap and add the copy. |
Definition at line 500 of file Grid.cc.
References libdap::Constructor::_vars, libdap::Array::ptr_duplicate(), and libdap::BaseType::set_parent().
void libdap::Grid::print_decl | ( | ostream & | out, |
string | space = " " , |
||
bool | print_semi = true , |
||
bool | constraint_info = false , |
||
bool | constrained = false |
||
) | [virtual] |
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];
While a more complex declaration (for a Grid, in this case), would look like this:
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. |
Reimplemented from libdap::Constructor.
Definition at line 776 of file Grid.cc.
References libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::print_decl(), projection_yields_grid(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().
Referenced by print_val().
void libdap::Grid::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 986 of file Grid.cc.
References print_decl(), libdap::BaseType::print_val(), projection_yields_grid(), and libdap::BaseType::send_p().
void libdap::Grid::print_xml | ( | ostream & | out, |
string | space = " " , |
||
bool | constrained = false |
||
) | [virtual] |
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::Constructor.
Definition at line 912 of file Grid.cc.
References get_array(), libdap::BaseType::get_attr_table(), libdap::id2xml(), map_begin(), map_end(), libdap::BaseType::name(), libdap::Array::print_xml(), libdap::AttrTable::print_xml(), projection_yields_grid(), and libdap::BaseType::send_p().
bool libdap::Grid::projection_yields_grid | ( | ) | [virtual] |
Returns TRUE if the current projection will yield a Grid that will pass the check_semantics()
function. A Grid that, when projected, will not pass the check_semantics()
function must be sent as either a Structure of Arrays or a single Array depending on the projection.
The function first checks to see whether the Array is present. Then, for each dimension in the Array part, the function checks the corresponding Map vector to make sure it is present in the projected Grid. If for each projected dimension in the Array component, there is a matching Map vector, then the Grid is valid.
Definition at line 666 of file Grid.cc.
References components(), libdap::Array::dim_begin(), libdap::Array::dim_end(), libdap::Array::dimension_size(), libdap::Array::dimension_start(), libdap::Array::dimension_stop(), libdap::Array::dimension_stride(), map_begin(), map_end(), and libdap::BaseType::send_p().
Referenced by print_decl(), print_val(), and print_xml().
BaseType * libdap::Grid::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 121 of file Grid.cc.
References Grid().
Referenced by libdap::function_grid().
bool libdap::BaseType::read | ( | ) | [virtual, inherited] |
This method should be implemented for each of the data type classes (Byte, ..., Grid) when using the DAP class library to build a server. This method is only for DAP servers. The library provides a default definition here which throws an InternalErr exception unless the read_p property has been set. In that case it returns false, indicating that all the data have been read. The latter case can happen when building a constant value that needs to be passed to a function. The variable/constant is loaded with a value when it is created.
When implementing a new DAP server, the Byte, ..., Grid data type classes are usually specialized. In each of those specializations read() should be defined to read values from the data source and store them in the object's local buffer. The read() method is called by other methods in this library. When writing read(), follow these rules:
read_p
property (using the read_p() method) and read values only if the value of read_p() is false. Once the read() method reads data and stores it in the instance, it must set the value of the read_p
property to true using set_read_p(). If your read() methods fail to do this data may not serialize correctly. For Sequence::read(), your specialization must correctly manage the unsent_data
property and row count in addition to the read_p
property (handle the read_p
property as describe above). For a Sequence to serialize correctly, once all data from the Sequence has been read, unsent_data
property must be set to false (use Sequence::set_unsent_data()). Also, at that time the row number counter must be reset (use Sequence::reset_row_counter()). Typically the correct time to set unsent_data
to false and reset the row counter is the time when Sequence::read() return false indicating that all the data for the Sequence have been read. Failure to handle these tasks will break serialization of nested Sequences. Note that when Sequence::read() returns with a result of true (indicating there is more data to send, the value of the unsent_data
property should be true.
Also, if you server must handle nested sequences, be sure to read about subclassing set_read_p().
Reimplemented in libdap::Structure.
Definition at line 790 of file BaseType.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), libdap::ArrayGeoConstraint::apply_constraint_to_data(), libdap::GeoConstraint::flip_latitude_within_array(), libdap::function_geogrid(), libdap::function_grid(), libdap::function_linear_scale(), libdap::Vector::intern_data(), 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(), libdap::Sequence::read_row(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
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 444 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::Vector::intern_data(), libdap::Structure::intern_data(), 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(), libdap::Structure::read(), 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(), serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), libdap::Byte::serialize(), and libdap::Vector::set_value_slice_from_row_major_vector().
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 503 of file BaseType.cc.
Referenced by components(), intern_data(), print_decl(), libdap::Constructor::print_decl(), libdap::BaseType::print_decl(), libdap::Array::print_decl(), print_val(), print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), projection_yields_grid(), and serialize().
bool libdap::Grid::serialize | ( | 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.
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 236 of file Grid.cc.
References libdap::BaseType::dataset(), libdap::ConstraintEvaluator::eval_selection(), libdap::BaseType::read(), libdap::BaseType::read_p(), libdap::BaseType::send_p(), libdap::BaseType::serialize(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().
void libdap::Grid::set_array | ( | Array * | p_new_arr | ) | [virtual] |
Set the Array part of the Grid to point to the memory p_new_arr. Grid takes control of the memory (no copy is made). If there already exists an array portion, the old one will be deleted to avoid leaks.
p_new_arr | the object to store as the array part of the grid. |
Definition at line 424 of file Grid.cc.
References libdap::BaseType::set_parent().
Referenced by add_var().
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 539 of file BaseType.cc.
void libdap::Grid::set_in_selection | ( | bool | state | ) | [virtual] |
Set the in_selection property to state. This property indicates that the variable is used as a parameter to a constraint expression function or that it appears as an argument in a selection sub-expression. If set (true), implementations of the BaseType::read() method should read this variable.
state | Set the in_selection property to this state. |
Reimplemented from libdap::BaseType.
Definition at line 192 of file Grid.cc.
References libdap::BaseType::set_in_selection().
void libdap::BaseType::set_name | ( | const string & | n | ) | [virtual, inherited] |
Definition at line 217 of file BaseType.cc.
References libdap::BaseType::name(), and libdap::www2id().
Referenced by libdap::Vector::add_var(), libdap::Array::print_xml_core(), and libdap::Vector::set_name().
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 638 of file BaseType.cc.
Referenced by libdap::Vector::_duplicate(), libdap::Structure::_duplicate(), _duplicate(), add_map(), libdap::Vector::add_var(), libdap::Structure::add_var(), libdap::Sequence::add_var(), add_var(), prepend_map(), set_array(), and libdap::Vector::Vector().
void libdap::Grid::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.
state | Set the read_p property to this state. |
Reimplemented from libdap::BaseType.
Definition at line 180 of file Grid.cc.
References libdap::BaseType::set_read_p().
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
void libdap::Grid::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 168 of file Grid.cc.
References libdap::BaseType::set_send_p().
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 427 of file BaseType.cc.
void libdap::BaseType::set_type | ( | const Type & | t | ) | [inherited] |
Definition at line 245 of file BaseType.cc.
Referenced by libdap::Url::Url().
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 416 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 161 of file BaseType.cc.
References libdap::BaseType::type_name().
Referenced by libdap::GSEClause::GSEClause().
void libdap::Grid::transfer_attributes | ( | AttrTable * | at_container | ) | [virtual] |
Given an Attribute table, scavenge attributes from it and load them into this object and the variables it contains.
This implementation differes from the version in BaseType in that each of the children of the Constructor are passed an attribute container if one is found that matches the name of this Constructor variable.
at_containeer | Search for attributes in this container. |
Reimplemented from libdap::Constructor.
Definition at line 612 of file Grid.cc.
References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), array_var(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), libdap::BaseType::get_attr_table(), libdap::AttrTable::get_attr_table(), libdap::AttrTable::get_attr_type(), libdap::AttrTable::get_attr_vector(), libdap::AttrTable::get_name(), libdap::AttrTable::get_type(), libdap::AttrTable::is_global_attribute(), map_begin(), map_end(), libdap::BaseType::name(), libdap::AttrTable::set_is_global_attribute(), and libdap::BaseType::transfer_attributes().
Type libdap::BaseType::type | ( | ) | const [inherited] |
Definition at line 238 of file BaseType.cc.
Referenced by libdap::Array::add_var(), libdap::Vector::buf2val(), check_semantics(), libdap::Vector::deserialize(), libdap::Vector::dump(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::function_linear_scale(), libdap::XDRStreamUnMarshaller::get_vector(), libdap::XDRFileUnMarshaller::get_vector(), libdap::Vector::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Vector::is_cardinal_type(), 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::reserve_value_capacity(), 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_value_slice_from_row_major_vector(), libdap::Vector::set_vec(), libdap::Vector::val2buf(), libdap::Vector::value(), and libdap::Vector::var().
string libdap::BaseType::type_name | ( | ) | const [inherited] |
Definition at line 252 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(), libdap::Structure::check_semantics(), libdap::Sequence::check_semantics(), libdap::Vector::deserialize(), libdap::BaseType::dump(), libdap::DDS::mark(), 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::Grid::val2buf | ( | void * | buf, |
bool | reuse = false |
||
) | [virtual] |
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.
Reimplemented from libdap::BaseType.
Definition at line 302 of file Grid.cc.
References var().
Note the parameter exact_match is not used by this member function.
Reimplemented from libdap::BaseType.
Definition at line 312 of file Grid.cc.
References libdap::BaseType::name(), and libdap::www2id().
Referenced by libdap::GSEClause::GSEClause(), and var().
Constructor::Vars_iter libdap::Constructor::var_begin | ( | ) | [inherited] |
Returns an iterator referencing the first structure element.
Definition at line 101 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(), libdap::Structure::set_leaf_sequence(), and libdap::Constructor::transfer_attributes().
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 295 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(), libdap::Structure::set_leaf_sequence(), and libdap::Constructor::transfer_attributes().
Constructor::Vars_riter libdap::Constructor::var_rbegin | ( | ) | [inherited] |
Return a reverse iterator that references the last element.
Definition at line 302 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 310 of file Constructor.cc.
References libdap::Constructor::_vars.
unsigned int libdap::Grid::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 204 of file Grid.cc.
References libdap::BaseType::width().
std::vector<BaseType *> libdap::Constructor::_vars [protected, inherited] |
Definition at line 48 of file Constructor.h.
Referenced by libdap::Structure::_duplicate(), add_map(), libdap::Structure::add_var(), libdap::Sequence::add_var(), add_var(), libdap::Structure::check_semantics(), libdap::Sequence::check_semantics(), libdap::Structure::del_var(), libdap::Structure::deserialize(), libdap::Sequence::deserialize(), libdap::Constructor::dump(), libdap::Structure::element_count(), libdap::Sequence::element_count(), libdap::Constructor::get_var_index(), libdap::Constructor::get_vars_iter(), libdap::Structure::intern_data(), libdap::Structure::is_linear(), libdap::Sequence::is_linear(), prepend_map(), libdap::Constructor::print_decl(), libdap::Structure::print_val(), libdap::Structure::read(), libdap::Structure::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), libdap::Structure::set_in_selection(), libdap::Sequence::set_in_selection(), libdap::Sequence::set_leaf_sequence(), libdap::Structure::set_read_p(), libdap::Sequence::set_read_p(), libdap::Structure::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(), libdap::Structure::width(), libdap::Sequence::width(), libdap::Sequence::~Sequence(), and libdap::Structure::~Structure().