libdap::Grid Class Reference

Holds the Grid data type. More...

#include <Grid.h>

Inheritance diagram for libdap::Grid:

Inheritance graph
[legend]
Collaboration diagram for libdap::Grid:

Collaboration graph
[legend]

List of all members.

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 void add_var (BaseType *bt, Part part)
BaseTypearray_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.
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.
Arrayget_array ()
 Returns the Grid Array. This method returns the array using an Array*, so no cast is required.
virtual AttrTableget_attr_table ()
Map_iter get_map_iter (int i)
virtual BaseTypeget_parent ()
BaseTypeget_var_index (int i)
Vars_iter get_vars_iter (int i)
 Grid (const Grid &rhs)
 The Grid copy constructor.
 Grid (const string &n="")
 The Grid constructor.
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.
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.
Gridoperator= (const Grid &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 bool projection_yields_grid ()
virtual BaseTypeptr_duplicate ()
virtual bool read (const string &dataset)
 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 (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)
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::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 *buf, bool reuse=false)
 Returns the size of the Grid type.
virtual BaseTypevar (const string &name, btp_stack &s)
virtual BaseTypevar (const string &name="", bool exact_match=true, btp_stack *s=0)
 Returns a pointer to a member of a constructor class.
virtual BaseTypevar (const string &n, btp_stack &s)
virtual BaseTypevar (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 BaseType &bt)
 Perform a deep copy.
void _duplicate (const Constructor &s)
virtual AttrTablefind_matching_container (AttrTable::entry *source, BaseType **dest_variable)

Protected Attributes

std::vector< BaseType * > _vars


Detailed Description

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.

Todo:
Move, in some sense, the _map_vars up to Constructor. Look at using Constructor's _var field for these.
Todo:
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.
See also:
Array

Definition at line 121 of file Grid.h.


Member Typedef Documentation

typedef stack<BaseType *> libdap::BaseType::btp_stack [inherited]

Definition at line 211 of file BaseType.h.

typedef std::vector<BaseType *>::const_iterator libdap::Grid::Map_citer

Definition at line 135 of file Grid.h.

typedef std::vector<BaseType *>::iterator libdap::Grid::Map_iter

Definition at line 136 of file Grid.h.

typedef std::vector<BaseType *>::reverse_iterator libdap::Grid::Map_riter

Definition at line 137 of file Grid.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.


Constructor & Destructor Documentation

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.

Parameters:
n A string containing the name of the variable to be created.

Definition at line 78 of file Grid.cc.

Referenced by ptr_duplicate().

libdap::Grid::Grid ( const Grid rhs  ) 

Definition at line 82 of file Grid.cc.

libdap::Grid::~Grid (  )  [virtual]

Definition at line 87 of file Grid.cc.


Member Function Documentation

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.

Parameters:
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]

Definition at line 57 of file Constructor.cc.

Referenced by libdap::Constructor::operator=().

void libdap::Grid::add_var ( BaseType bt,
Part  part 
) [virtual]

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.

Parameters:
bt Array or Map variable
part is this an array or a map. If not present, first bt is the array and subsequent bts are maps.

Reimplemented from libdap::BaseType.

Definition at line 318 of file Grid.cc.

References libdap::array, libdap::maps, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().

Here is the call graph for this function:

BaseType * libdap::Grid::array_var (  ) 

Deprecated:
See also:
get_array()

Definition at line 357 of file Grid.cc.

unsigned int libdap::Grid::buf2val ( void **  val  )  [virtual]

Returns the size of the Grid type. Use the buf2val() functions of the member elements to read values from the Grid buffer.

Implements libdap::BaseType.

Definition at line 268 of file Grid.cc.

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 806 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(), libdap::BaseType::type_name(), libdap::unique_names(), and libdap::Vector::var().

Here is the call graph for this function:

void libdap::Grid::clear_constraint (  )  [virtual]

For each of the Array and Maps in this Grid, call clear_constraint().

Definition at line 506 of file Grid.cc.

References map_begin(), and map_end().

Here is the call graph for this function:

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.

Returns:
The number of components in the Grid object.
Parameters:
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 426 of file Grid.cc.

References libdap::BaseType::send_p().

Referenced by print_decl().

Here is the call graph for this function:

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.

Parameters:
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.
Returns:
Always returns TRUE.
Exceptions:
Error when a problem reading from the UnMarshaller is found.
See also:
DDS

Implements libdap::BaseType.

Definition at line 240 of file Grid.cc.

References libdap::BaseType::deserialize().

Here is the call graph for this function:

void libdap::Grid::dump ( ostream &  strm  )  const [virtual]

Displays the pointer value of this instance and information about this instance.

Parameters:
strm C++ i/o stream to dump the information to
Returns:
void

Reimplemented from libdap::Constructor.

Definition at line 908 of file Grid.cc.

References libdap::BaseType::dump(), libdap::Constructor::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().

Here is the call graph for this function:

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.

Returns:
Returns 1 for simple types. For compound members, the count depends on the leaves argument.
Parameters:
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 124 of file Grid.cc.

References libdap::Vector::element_count(), and get_array().

Here is the call graph for this function:

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:

Array * libdap::Grid::get_array (  ) 

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(), print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::Array::print_xml_core().

Grid::Map_iter libdap::Grid::get_map_iter ( int  i  ) 

Return the iterator for the ith map.

Parameters:
i the index
Returns:
The corresponding Vars_iter

Definition at line 405 of file Grid.cc.

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.

Returns:
A BaseType pointer to the variable's parent.

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.

Parameters:
i This index
Returns:
The corresponding BaseType*.

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.

Parameters:
i the index
Returns:
The corresponding Vars_iter

Definition at line 261 of file Constructor.cc.

References libdap::Constructor::_vars.

void libdap::Grid::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.

Parameters:
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 188 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().

Here is the call graph for this function:

bool libdap::BaseType::is_constructor_type (  )  [virtual, inherited]

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.

Note:
This method does not check, nor does it know about the semantics of, string arguments passed to functions. Those functions might include variable names in strings; they are responsible for reading those variables. See the grid (func_grid_select()) for an example.
See also:
BaseType::read()

Definition at line 505 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.

Todo:
Change the name to is_flattenable or something like that. 05/16/03 jhrg
Returns:
True if the instance can be printed as a single table of values, false otherwise.

Reimplemented in libdap::Sequence, and libdap::Structure.

Definition at line 427 of file Constructor.cc.

bool libdap::BaseType::is_simple_type (  )  [virtual, inherited]

bool libdap::BaseType::is_vector_type (  )  [virtual, inherited]

Grid::Map_iter libdap::Grid::map_begin (  ) 

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 381 of file Grid.cc.

Referenced by clear_constraint(), libdap::function_geogrid(), libdap::function_grid(), print_xml(), and projection_yields_grid().

Grid::Map_riter libdap::Grid::map_rbegin (  ) 

Definition at line 388 of file Grid.cc.

Grid::Map_riter libdap::Grid::map_rend (  ) 

Returns an iterator referencing the end of the list of Map vectors. It does not reference the last Map vector

Definition at line 396 of file Grid.cc.

string libdap::BaseType::name (  )  const [inherited]

Grid & libdap::Grid::operator= ( const Grid rhs  ) 

Definition at line 104 of file Grid.cc.

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.

Parameters:
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).
Returns:
The boolean value of the comparison.

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::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;
    

Parameters:
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.
See also:
DDS

DDS::CE

Reimplemented from libdap::Constructor.

Definition at line 584 of file Grid.cc.

References components(), libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::print_decl(),