Grid Class Reference

Holds the Grid data type. More...

#include <Grid.h>

Inheritance diagram for Grid:

Inheritance graph
[legend]
Collaboration diagram for Grid:

Collaboration graph
[legend]
List of all members.

Public Types

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 (XDR *source, 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 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 (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 (FILE *out, string space="", bool print_decl_p=true)
 Prints the value of the variable.
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, XDR *sink, 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 &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.
xdrproc_t xdr_coder ()
 Returns a function used to encode elements of an array.
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.

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 118 of file Grid.h.


Member Typedef Documentation

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

Definition at line 132 of file Grid.h.

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

Definition at line 133 of file Grid.h.

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

Definition at line 134 of file Grid.h.

typedef std::vector<BaseType *>::const_iterator Constructor::Vars_citer [inherited]

Definition at line 51 of file Constructor.h.

typedef std::vector<BaseType *>::iterator Constructor::Vars_iter [inherited]

Definition at line 52 of file Constructor.h.

typedef std::vector<BaseType *>::reverse_iterator Constructor::Vars_riter [inherited]

Definition at line 53 of file Constructor.h.


Constructor & Destructor Documentation

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

Referenced by ptr_duplicate().

Grid::Grid ( const Grid rhs  ) 

Definition at line 80 of file Grid.cc.

Grid::~Grid (  )  [virtual]

Definition at line 85 of file Grid.cc.


Member Function Documentation

void 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 64 of file BaseType.cc.

References BaseType::_name, BaseType::_read_p, BaseType::_send_p, BaseType::_synthesized_p, BaseType::_type, BaseType::_xdr_coder, BaseType::d_attr, BaseType::d_in_selection, and BaseType::d_parent.

Referenced by BaseType::BaseType(), and BaseType::operator=().

void Constructor::_duplicate ( const Constructor s  )  [protected, inherited]

Definition at line 55 of file Constructor.cc.

Referenced by Constructor::operator=().

void 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 BaseType.

Definition at line 296 of file Grid.cc.

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

Here is the call graph for this function:

BaseType * Grid::array_var (  ) 

Deprecated:
See also:
get_array()

Definition at line 335 of file Grid.cc.

unsigned int 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 BaseType.

Definition at line 246 of file Grid.cc.

bool 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 BaseType.

Definition at line 638 of file Grid.cc.

References BaseType::check_semantics(), Array::dim_begin(), Array::dimension_size(), Array::dimensions(), dods_array_c, BaseType::is_simple_type(), BaseType::name(), BaseType::type(), BaseType::type_name(), unique_names(), and Vector::var().

Here is the call graph for this function:

void Grid::clear_constraint (  )  [virtual]

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

Definition at line 484 of file Grid.cc.

References map_begin(), and map_end().

Here is the call graph for this function:

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

References BaseType::send_p().

Referenced by print_decl().

Here is the call graph for this function:

bool Grid::deserialize ( XDR *  source,
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:
source A valid XDR pointer to the process connection to the net. This is generally created with a call to new_xdrstdio().
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 XDR stream is found.
See also:
DDS

Implements BaseType.

Definition at line 218 of file Grid.cc.

References BaseType::deserialize().

Here is the call graph for this function:

void 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 Constructor.

Definition at line 740 of file Grid.cc.

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

Here is the call graph for this function:

int 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 BaseType.

Definition at line 122 of file Grid.cc.

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

Here is the call graph for this function:

AttrTable * 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 130 of file Constructor.cc.

References AttrTable::append_container(), Attr_container, DBG, dods_grid_c, AttrTable::find_container(), BaseType::get_attr_table(), BaseType::get_parent(), AttrTable::entry::name, BaseType::type(), AttrTable::entry::type, and BaseType::var().

Referenced by Constructor::transfer_attributes().

Here is the call graph for this function:

Array * Grid::get_array (  ) 

Returns:
A pointer to the Grid's (dependent) data array

Definition at line 344 of file Grid.cc.

Referenced by GridGeoConstraint::apply_constraint_to_data(), element_count(), libdap::function_geogrid(), libdap::function_grid(), GridGeoConstraint::GridGeoConstraint(), and print_xml().

AttrTable & 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 DDS::find_matching_container(), Constructor::find_matching_container(), print_xml(), Constructor::print_xml(), BaseType::print_xml(), and Array::print_xml_core().

Grid::Map_iter 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 383 of file Grid.cc.

BaseType * 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 DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_two(), Sequence::transfer_data_for_leaf(), and Sequence::transfer_data_parent_part_two().

BaseType * 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 266 of file Constructor.cc.

References Constructor::_vars.

Constructor::Vars_iter 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 257 of file Constructor.cc.

References Constructor::_vars.

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

Definition at line 307 of file BaseType.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and BaseType::type().

Referenced by DDXParser::ddx_end_element(), DDS::transfer_attributes(), Constructor::transfer_attributes(), and Vector::var().

Here is the call graph for this function:

bool 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 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 Sequence, and Structure.

Definition at line 354 of file Constructor.cc.

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

Definition at line 250 of file BaseType.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and BaseType::type().

Referenced by 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 BaseType::is_vector_type (  )  [virtual, inherited]

Definition at line 277 of file BaseType.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and BaseType::type().

Referenced by DDXParser::ddx_end_element().

Here is the call graph for this function:

Grid::Map_iter Grid::map_begin (  ) 

Definition at line 351 of file Grid.cc.

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

Grid::Map_iter 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 359 of file Grid.cc.

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

Grid::Map_riter Grid::map_rbegin (  ) 

Definition at line 366 of file Grid.cc.

Grid::Map_riter 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 374 of file Grid.cc.

string BaseType::name (  )  const [inherited]

Definition at line 181 of file BaseType.cc.

Referenced by Structure::_duplicate(), Vector::add_var(), Structure::check_semantics(), Sequence::check_semantics(), check_semantics(), Sequence::deserialize(), DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), GSEClause::get_map_name(), GridGeoConstraint::GridGeoConstraint(), GSEClause::GSEClause(), DDS::mark(), print_decl(), Constructor::print_decl(), print_xml(), Constructor::print_xml(), Array::print_xml_core(), Sequence::read_row(), Sequence::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_one(), Sequence::serialize_parent_part_two(), Sequence::set_leaf_sequence(), BaseType::set_name(), BaseType::set_read_p(), Constructor::transfer_attributes(), Sequence::transfer_data(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), Sequence::transfer_data_parent_part_two(), Sequence::transfer_data_private(), rvalue::value_name(), Vector::var(), Structure::var(), Sequence::var(), and var().

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

Definition at line 102 of file Grid.cc.

bool 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 Byte, Float32, Float64, Int16, Int32, Str, UInt16, and UInt32.

Definition at line 898 of file BaseType.cc.

Referenced by Clause::value().

void Grid::print_decl ( FILE *  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 Constructor.

Definition at line 492 of file Grid.cc.

References components(), id2www(), BaseType::name(), BaseType::print_decl(), projection_yields_grid(), BaseType::send_p(), and BaseType::type_name().

Referenced by print_val().

Here is the call graph for this function:

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

Parameters:
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 BaseType.

Definition at line 602 of file Grid.cc.

References print_decl(), BaseType::print_val(), projection_yields_grid(), and BaseType::send_p().

Here is the call graph for this function:

void Grid::print_xml ( FILE *  out,
string  space = "    ",
bool  constrained = false 
) [virtual]

Write the XML representation of this variable. This method is used to build the DDX XML response.

Parameters:
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 Constructor.

Definition at line 580 of file Grid.cc.

References get_array(), BaseType::get_attr_table(), id2xml(), map_begin(), map_end(), BaseType::name(), Array::print_xml(), AttrTable::print_xml(), and BaseType::send_p().

Here is the call graph for this function:

bool 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.

Returns:
TRUE if the projected grid is still a Grid. FALSE otherwise.

Definition at line 444 of file Grid.cc.

References Array::dim_begin(), Array::dim_end(), Array::dimension_size(), Array::dimension_start(), Array::dimension_stop(), Array::dimension_stride(), map_begin(), map_end(), and BaseType::send_p().

Referenced by print_decl(), and print_val().

Here is the call graph for this function:

BaseType * Grid::ptr_duplicate (  )  [virtual]

Clone this instance. Allocate a new instance and copy *this into it. This method must perform a deep copy.

Note:
This method should not copy data values, but must copy all other fields in the object.
Returns:
A newly allocated copy of this.

Implements BaseType.

Definition at line 96 of file Grid.cc.

References Grid().

Referenced by libdap::function_grid().

Here is the call graph for this function:

bool BaseType::read ( const string &  dataset  )  [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:

Returns:
The return value of this method for all types except Sequence should always be false. Sequences should return true to indicate more values remain in the Sequence, false to indicate no more values remain. (see Sequence::serialize() and Sequence::read_row()).
Parameters:
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.
See also:
BaseType

Sequence

Reimplemented in PassiveArray, PassiveByte, PassiveFloat32, PassiveFloat64, PassiveInt16, PassiveInt32, PassiveStr, PassiveStructure, PassiveUInt16, and PassiveUInt32.

Definition at line 690 of file BaseType.cc.

Referenced by GridGeoConstraint::apply_constraint_to_data(), ArrayGeoConstraint::apply_constraint_to_data(), libdap::function_geogrid(), libdap::function_grid(), libdap::function_linear_scale(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Sequence::read_row(), GeoConstraint::reorder_data_longitude_axis(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Structure::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), serialize(), Float64::serialize(), Float32::serialize(), Byte::serialize(), and Structure::transfer_data().

bool 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.

Returns:
True if the variable's value(s) have been read, false otherwise.

Definition at line 395 of file BaseType.cc.

Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), PassiveUInt32::read(), PassiveUInt16::read(), PassiveStr::read(), PassiveInt32::read(), PassiveInt16::read(), PassiveFloat64::read(), PassiveFloat32::read(), PassiveByte::read(), PassiveArray::read(), Sequence::read_row(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Structure::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), serialize(), Float64::serialize(), Float32::serialize(), Byte::serialize(), and Structure::transfer_data().

bool 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.

Returns:
True if the variable should be sent to the client, false otherwise.

Definition at line 453 of file BaseType.cc.

Referenced by components(), print_decl(), Constructor::print_decl(), BaseType::print_decl(), Array::print_decl(), print_val(), print_xml(), Constructor::print_xml(), BaseType::print_xml(), Array::print_xml_core(), projection_yields_grid(), and serialize().

bool Grid::serialize ( const string &  dataset,
ConstraintEvaluator eval,
DDS dds,
XDR *  sink,
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.

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.
sink A valid XDR pointer generally created with a call to new_xdrstdio(). This typically routes data to a TCP/IP socket.
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.
Returns:
This method always returns true. Older versions used the return value to signal success or failure.
Exceptions:
InternalErr. 
Error. 
See also:
DDS

Implements BaseType.

Definition at line 186 of file Grid.cc.

References ConstraintEvaluator::eval_selection(), BaseType::read(), BaseType::read_p(), BaseType::send_p(), BaseType::serialize(), DDS::timeout_off(), and DDS::timeout_on().

Here is the call graph for this function:

void BaseType::set_attr_table ( const AttrTable at  )  [virtual, inherited]

Set this variable's attribute table.

Parameters:
at Source of the attributes.

Definition at line 488 of file BaseType.cc.

void 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.

Parameters:
state Set the in_selection property to this state.
See also:
BaseType::read()

BaseType::is_in_selection() for more information.

Reimplemented from BaseType.

Definition at line 162 of file Grid.cc.

References BaseType::set_in_selection().

Here is the call graph for this function:

void BaseType::set_name ( const string &  n  )  [virtual, inherited]

Definition at line 188 of file BaseType.cc.

References BaseType::name(), and www2id().

Referenced by Vector::add_var(), and Array::print_xml_core().

Here is the call graph for this function:

void BaseType::set_parent ( BaseType parent  )  [virtual, inherited]

Set the parent property for this variable. Only instances of Constructor or Vector should call this method.

Parameters:
parent Pointer to the Constructor of Vector parent variable.
Exceptions:
InternalErr thrown if called with anything other than a Constructor or Vector.

Definition at line 533 of file BaseType.cc.

Referenced by Vector::_duplicate(), Structure::_duplicate(), Vector::add_var(), Structure::add_var(), Sequence::add_var(), add_var(), and Vector::Vector().

void 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.

Note:
For most of the types the default implementation of this method is fine. However, if you're building a server which must handle data represented using nested sequences, then you may need to provide a specialization of Sequence::set_read_p(). By default Sequence::set_read_() recursively sets the read_p property for all child variables to state. For servers where one Sequence reads an outer set of values and another reads an inner set, this is cumbersome. In such a case, it is easier to specialize Sequence::set_read_p() so that it does not recursively set the read_p property for the inner Sequence. Be sure to see the documentation for the read() method!

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.

Todo:
Look at making synthesized variables easier to implement and at making them more integrated into the overall CE evaluation process. Maybe the code that computes the synthesized var's value should be in the that variable's read() method? This might provide a way to get rid of the awkward 'projection functions' by replacing them with real children of BaseType. It would also provide a way to clean up the way the synthesized_p prop intrudes on the read_p prop.
See also:
BaseType::read()
Parameters:
state Set the read_p property to this state.

Reimplemented from BaseType.

Definition at line 150 of file Grid.cc.

References BaseType::set_read_p().

Referenced by GridGeoConstraint::apply_constraint_to_data().

Here is the call graph for this function:

void Grid::set_send_p ( bool  state  )  [virtual]

Sets the value of the send_p flag. This function is meant to be called from serialize(). Data is ready to be sent when both the _send_p and _read_p flags are set to TRUE.

Parameters:
state The logical state to set the send_p flag.

Reimplemented from BaseType.

Definition at line 138 of file Grid.cc.

References BaseType::set_send_p().

Here is the call graph for this function:

void 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!

See also:
synthesized_p()

Definition at line 378 of file BaseType.cc.

void BaseType::set_type ( const Type t  )  [inherited]

Definition at line 203 of file BaseType.cc.

Referenced by Url::Url().

bool 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 367 of file BaseType.cc.

string 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.

Returns:
A string which shows the object's internal stuff.

Reimplemented in Sequence.

Definition at line 134 of file BaseType.cc.

References BaseType::type_name().

Referenced by Sequence::add_var(), GSEClause::GSEClause(), and Sequence::toString().

Here is the call graph for this function:

void 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.

Note:
This method is technically unnecessary because a server (or client) can easily add attributes directly using the DDS::get_attr_table or BaseType::get_attr_table methods and then poke values in using any of the methods AttrTable provides. This method exists to ease the transition to DDS objects which contain attribute information for the existing servers (Since they all make DAS objects separately from the DDS). They could be modified to use the same AttrTable methods but operate on the AttrTable instances in a DDS/BaseType instead of those in a DAS.
Parameters:
at Get attribute information from this Attribute table.

Definition at line 191 of file Constructor.cc.

References AttrTable::append_attr(), AttrTable::append_container(), AttrTable::attr_begin(), Attr_container, AttrTable::attr_end(), AttrTable::entry::attributes, DBG, Constructor::find_matching_container(), AttrTable::get_attr_vector(), AttrTable::get_name(), AttrTable::get_type(), BaseType::is_constructor_type(), BaseType::name(), and AttrTable::entry::type.

Here is the call graph for this function:

Type BaseType::type (  )  const [inherited]

Definition at line 196 of file BaseType.cc.

Referenced by Array::add_var(), Vector::buf2val(), check_semantics(), Vector::deserialize(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), BaseType::is_constructor_type(), BaseType::is_simple_type(), BaseType::is_vector_type(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Sequence::print_one_row(), PassiveArray::read(), Vector::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_two(), libdap::set_array_using_double(), Vector::set_value(), PassiveArray::set_value(), Vector::set_vec(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_two(), Vector::val2buf(), Vector::value(), and Vector::var().

string BaseType::type_name (  )  const [inherited]

Definition at line 210 of file BaseType.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, and dods_url_c.

Referenced by Vector::add_var(), Structure::check_semantics(), Sequence::check_semantics(), check_semantics(), Vector::deserialize(), BaseType::dump(), print_decl(), Constructor::print_decl(), BaseType::print_decl(), Constructor::print_xml(), BaseType::print_xml(), and BaseType::toString().

unsigned int Grid::val2buf ( void *  buf,
bool  reuse = false 
) [virtual]

Use the val2buf() functions of the member elements to insert values into the Grid buffer.

Returns:
The size (in bytes) of the value's representation.

Implements BaseType.

Definition at line 237 of file Grid.cc.

BaseType * Grid::var ( const string &  n,
btp_stack s 
) [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.

Note:
The BaseType implementation always returns null. There are no default values for the parameters. If var() is called w/o any params, the three parameter version will be used.
Deprecated:
This method is deprecated because it tries first to use exact_match and, if that fails, then tries leaf_match. It's better to use the alternate form of var(...) and specify exactly what you'd like to do.
Returns:
A pointer to the named variable.

Reimplemented from BaseType.

Definition at line 252 of file Grid.cc.

References var().

Here is the call graph for this function:

BaseType * Grid::var ( const string &  n,
bool  exact = true,
btp_stack s = 0 
) [virtual]

Note the parameter exact_match is not used by this member function.

See also:
BaseType

Reimplemented from BaseType.

Definition at line 262 of file Grid.cc.

References BaseType::name(), and www2id().

Referenced by GSEClause::GSEClause(), and var().

Here is the call graph for this function:

Constructor::Vars_iter Constructor::var_begin (  )  [inherited]

Returns an iterator referencing the first structure element.

Definition at line 85 of file Constructor.cc.

References Constructor::_vars.

Referenced by DDXParser::ddx_end_document(), Constructor::print_xml(), Structure::set_leaf_sequence(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), and Sequence::transfer_data_parent_part_two().

Constructor::Vars_iter 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 233 of file Constructor.cc.

References Constructor::_vars.

Referenced by DDXParser::ddx_end_document(), Constructor::print_xml(), Structure::set_leaf_sequence(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), and Sequence::transfer_data_parent_part_two().

Constructor::Vars_riter Constructor::var_rbegin (  )  [inherited]

Return a reverse iterator that references the last element.

Definition at line 240 of file Constructor.cc.

References Constructor::_vars.

Constructor::Vars_riter Constructor::var_rend (  )  [inherited]

Return a reverse iterator that references a point 'before' the first element.

Definition at line 248 of file Constructor.cc.

References Constructor::_vars.

unsigned int 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 BaseType.

Definition at line 174 of file Grid.cc.

References BaseType::width().

Here is the call graph for this function:

xdrproc_t BaseType::xdr_coder (  )  [inherited]

The xdr_coder function (also "filter primitive") is used to encode and decode each element in a multiple element data structure. These functions are used to convert data to and from its local representation to the XDR representation, which is used to transmit and receive the data. See man xdr for more information about the available XDR filter primitives.

Note that this class data is only used for multiple element data types. The simple data types (Int, Float, and so on), are translated directly.

Returns:
A C function used to encode data in the XDR format.

Definition at line 713 of file BaseType.cc.

Referenced by Vector::deserialize(), and Vector::serialize().


Member Data Documentation

std::vector<BaseType *> Constructor::_vars [protected, inherited]

Definition at line 44 of file Constructor.h.

Referenced by Structure::_duplicate(), Structure::add_var(), Sequence::add_var(), Structure::check_semantics(), Sequence::check_semantics(), Structure::deserialize(), Sequence::deserialize(), Constructor::dump(), Structure::element_count(), Sequence::element_count(), Constructor::get_var_index(), Constructor::get_vars_iter(), Structure::is_linear(), Sequence::is_linear(), Constructor::print_decl(), Structure::print_val(), PassiveStructure::read(), Structure::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_one(), Sequence::serialize_parent_part_two(), Structure::set_in_selection(), Sequence::set_in_selection(), Sequence::set_leaf_sequence(), Structure::set_read_p(), Sequence::set_read_p(), Structure::set_send_p(), Sequence::set_send_p(), Sequence::toString(), Structure::transfer_data(), Constructor::var_begin(), Constructor::var_end(), Constructor::var_rbegin(), Constructor::var_rend(), Structure::width(), Sequence::width(), Sequence::~Sequence(), and Structure::~Structure().


The documentation for this class was generated from the following files:
Generated on Wed Jun 27 12:57:56 2007 for libdap++ by  doxygen 1.4.7