libdap++ Updated for version 3.8.2

libdap::Array Class Reference

A multidimensional array of identical data types. More...

#include <Array.h>

Inheritance diagram for libdap::Array:
Collaboration diagram for libdap::Array:

List of all members.

Classes

struct  dimension

Public Types

typedef stack< BaseType * > btp_stack
typedef std::vector< dimension >
::const_iterator 
Dim_citer
typedef std::vector< dimension >
::iterator 
Dim_iter

Public Member Functions

virtual void add_constraint (Dim_iter i, int start, int stride, int stop)
 Adds a constraint to an Array dimension.
void add_var (BaseType *v, Part p=nil)
 Add the BaseType pointer to this constructor type instance.
void append_dim (int size, string name="")
 Add a dimension of a given size.
 Array (const string &n, const string &d, BaseType *v)
 Array constructor.
 Array (const string &n, BaseType *v)
 Array constructor.
 Array (const Array &rhs)
 The Array copy constructor.
virtual unsigned int buf2val (void **val)
virtual bool check_semantics (string &msg, bool all=false)
 Check semantic features of the Array.
virtual void clear_constraint ()
 Clears the projection; add each projected dimension explicitly using add_constraint.
void clear_local_data ()
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.
Dim_iter dim_begin ()
Dim_iter dim_end ()
virtual string dimension_name (Dim_iter i)
 Returns the name of the specified dimension.
virtual int dimension_size (Dim_iter i, bool constrained=false)
 Returns the size of the dimension.
virtual int dimension_start (Dim_iter i, bool constrained=false)
 Return the start index of a dimension.
virtual int dimension_stop (Dim_iter i, bool constrained=false)
 Return the stop index of the constraint.
virtual int dimension_stride (Dim_iter i, bool constrained=false)
 Returns the stride value of the constraint.
virtual unsigned int dimensions (bool constrained=false)
 Return the total number of dimensions in the array.
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int element_count (bool leaves)
 Count the members of constructor types.
virtual AttrTableget_attr_table ()
virtual BaseTypeget_parent ()
virtual unsigned int get_value_capacity () const
virtual void intern_data (ConstraintEvaluator &eval, DDS &dds)
 read data into a variable for later use
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_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.
virtual int length () const
string name () const
 Returns the name of the class instance.
Arrayoperator= (const Array &rhs)
virtual bool ops (BaseType *b, int op)
 Evaluate relational operators.
void prepend_dim (int size, const string &name="")
virtual void print_as_map_xml (ostream &out, string space=" ", bool constrained=false)
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Prints a DDS entry for the Array.
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 void print_xml_core (ostream &out, string space, bool constrained, string tag)
virtual BaseTypeptr_duplicate ()
virtual bool read ()
 Read data into a local buffer.
virtual bool read_p ()
 Has this variable been read?
virtual void reserve_value_capacity ()
virtual void reserve_value_capacity (unsigned int numElements)
virtual void reset_constraint ()
 Reset constraint to select entire array.
virtual bool send_p ()
 Should this variable be sent?
virtual bool serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
 Serialize a Vector.
virtual void set_attr_table (const AttrTable &at)
virtual void set_in_selection (bool state)
virtual void set_length (int l)
virtual void set_name (const std::string &name)
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)
 Indicates that the data is ready to send.
virtual void set_send_p (bool state)
 Indicates that the data is ready to send.
virtual void set_synthesized_p (bool state)
void set_type (const Type &t)
 Sets the type of the class instance.
virtual unsigned int set_value_slice_from_row_major_vector (const Vector &rowMajorData, unsigned int startElement)
void set_vec (unsigned int i, BaseType *val)
 Sets element i to value val.
virtual bool synthesized_p ()
virtual string toString ()
virtual void transfer_attributes (AttrTable *at)
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 void update_length (int size)
virtual unsigned int val2buf (void *val, bool reuse=false)
 Reads data into the Vector buffer.

Exceptions:
InternalErrThrown if called for Structure, Sequence or Grid.

virtual BaseTypevar (const string &name="", bool exact_match=true, btp_stack *s=0)
virtual BaseTypevar (unsigned int i)
virtual BaseTypevar (const string &name, btp_stack &s)
void vec_resize (int l)
virtual unsigned int width ()
 Returns the width of the data, in bytes.
virtual ~Array ()
 The Array destructor.
virtual bool set_value (dods_byte *val, int sz)
 set the value of a byte array
virtual bool set_value (vector< dods_byte > &val, int sz)
 set the value of a byte array
virtual bool set_value (dods_int16 *val, int sz)
 set the value of a int16 array
virtual bool set_value (vector< dods_int16 > &val, int sz)
 set the value of a int16 array
virtual bool set_value (dods_uint16 *val, int sz)
 set the value of a uint16 array
virtual bool set_value (vector< dods_uint16 > &val, int sz)
 set the value of a uint16 array
virtual bool set_value (dods_int32 *val, int sz)
 set the value of a int32 array
virtual bool set_value (vector< dods_int32 > &val, int sz)
 set the value of a int32 array
virtual bool set_value (dods_uint32 *val, int sz)
 set the value of a uint32 array
virtual bool set_value (vector< dods_uint32 > &val, int sz)
 set the value of a uint32 array
virtual bool set_value (dods_float32 *val, int sz)
 set the value of a float32 array
virtual bool set_value (vector< dods_float32 > &val, int sz)
 set the value of a float32 array
virtual bool set_value (dods_float64 *val, int sz)
 set the value of a float64 array
virtual bool set_value (vector< dods_float64 > &val, int sz)
 set the value of a float64 array
virtual bool set_value (string *val, int sz)
 set the value of a string or url array
virtual bool set_value (vector< string > &val, int sz)
 set the value of a string or url array
virtual void value (dods_byte *b) const
 Get a copy of the data held by this variable. Read data from this variable's internal storage and load it into the memory referenced by b. The argument b must point to enough memory to hold length() Bytes.
virtual void value (dods_int16 *b) const
 Get a copy of the data held by this variable.
virtual void value (dods_uint16 *b) const
 Get a copy of the data held by this variable.
virtual void value (dods_int32 *b) const
 Get a copy of the data held by this variable.
virtual void value (dods_uint32 *b) const
 Get a copy of the data held by this variable.
virtual void value (dods_float32 *b) const
 Get a copy of the data held by this variable.
virtual void value (dods_float64 *b) const
 Get a copy of the data held by this variable.
virtual void value (vector< string > &b) const
 Get a copy of the data held by this variable.
virtual void * value ()

Protected Member Functions

void _duplicate (const Array &a)
void _duplicate (const BaseType &bt)
 Perform a deep copy.
void _duplicate (const Vector &v)
unsigned int create_cardinal_data_buffer_for_type (unsigned int numEltsOfType)
void delete_cardinal_data_buffer ()
bool is_cardinal_type () const
unsigned int print_array (ostream &out, unsigned int index, unsigned int dims, unsigned int shape[])
 Print the value given the current constraint.
template<class CardType >
void set_cardinal_values_internal (const CardType *fromArray, int numElts)

Friends

class ArrayTest

Detailed Description

This class is used to hold arrays of data. The elements of the array can be simple or compound data types. There is no limit on the number of dimensions an array can have, or on the size of each dimension.

If desired, the user can give each dimension of an array a name. You can, for example, have a 360x180 array of temperatures, covering the whole globe with one-degree squares. In this case, you could name the first dimension Longitude and the second dimension Latitude. This can help prevent a great deal of confusion.

The Array is used as part of the Grid class, where the dimension names are crucial to its structure. The dimension names correspond to Map vectors, holding the actual values for that column of the array.

Each array dimension carries with it its own projection information. The projection information takes the form of three integers: the start, stop, and stride values. This is clearest with an example. Consider a one-dimensional array 10 elements long. If the start value of the dimension constraint is 3, then the constrained array appears to be seven elements long. If the stop value is changed to 7, then the array appears to be five elements long. If the stride is changed to two, the array will appear to be 3 elements long. Array constraints are written as: [start:stride:stop].

    A = [1 2 3 4 5 6 7 8 9 10]

    A[3::] = [4 5 6 7 8 9 10]

    A[3::7] = [4 5 6 7 8]

    A[3:2:7] = [4 6 8]

    A[0:3:9] = [1 4 7 10]
    
Note:
Arrays use zero-based indexing.
See also:
Grid
Vector
dimension

Definition at line 101 of file Array.h.


Member Typedef Documentation

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

Definition at line 214 of file BaseType.h.

typedef std::vector<dimension>::const_iterator libdap::Array::Dim_citer

A constant iterator used to access the various dimensions of an Array.

See also:
dim_begin()
dim_end()

Definition at line 145 of file Array.h.

typedef std::vector<dimension>::iterator libdap::Array::Dim_iter

An iterator used to access the various dimensions of an Array. Most of the methods that access various properties of a dimension use an instance of Dim_iter.

See also:
dim_begin()
dim_end()

Definition at line 152 of file Array.h.


Constructor & Destructor Documentation

libdap::Array::Array ( const string &  n,
BaseType v 
)

Build an array with a name and an element type. The name may be omitted, which will create a nameless variable. The template (element type) pointer may also be omitted, but if it is omitted when the Array is created, it must be added (with add_var()) before read() or deserialize() is called.

Todo:
Force the Array::add_var() method to be used to add v. This version of add_var() calls Vector::add_var().
Parameters:
nA string containing the name of the variable to be created.
vA pointer to a variable of the type to be included in the Array.

Definition at line 100 of file Array.cc.

References add_var().

Referenced by ptr_duplicate().

Here is the call graph for this function:

libdap::Array::Array ( const string &  n,
const string &  d,
BaseType v 
)

Build an array on the server-side with a name, a dataset name from which this Array is being created, and an element type.

Todo:
Force the Array::add_var() method to be used to add v. This version of add_var() calls Vector::add_var().
Parameters:
nA string containing the name of the variable to be created.
dA string containing the name of the dataset from which this variable is being created.
vA pointer to a variable of the type to be included in the Array.

Definition at line 118 of file Array.cc.

References add_var().

Here is the call graph for this function:

libdap::Array::Array ( const Array rhs)

Definition at line 125 of file Array.cc.

References _duplicate().

Here is the call graph for this function:

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

Definition at line 131 of file Array.cc.

References DBG.


Member Function Documentation

void libdap::Array::_duplicate ( const Array a) [protected]

Definition at line 53 of file Array.cc.

Referenced by Array(), and operator=().

void libdap::Vector::_duplicate ( const Vector v) [protected, inherited]

Definition at line 61 of file Vector.cc.

References libdap::BaseType::ptr_duplicate(), libdap::BaseType::set_parent(), and libdap::Vector::val2buf().

Referenced by libdap::Vector::operator=(), and libdap::Vector::Vector().

Here is the call graph for this function:

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:
btThe source object.

Definition at line 80 of file BaseType.cc.

References DBG.

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

void libdap::Array::add_constraint ( Dim_iter  i,
int  start,
int  stride,
int  stop 
) [virtual]

Once a dimension has been created (see append_dim()), it can be constrained. This will make the array appear to the rest of the world to be smaller than it is. This functions sets the projection for a dimension, and marks that dimension as part of the current projection.

Note:
A stride value <= 0 or > the array size is an error and causes add_constraint to throw an Error. Similarly, start or stop values > size also cause an Error exception to be thrown.
Parameters:
iAn iterator pointing to the dimension in the list of dimensions.
startThe start index of the constraint.
strideThe stride value of the constraint.
stopThe stop index of the constraint.
Exceptions:
ErrorThrown if the any of values of start, stop or stride cannot be applied to this array.

Definition at line 313 of file Array.cc.

References libdap::Array::dimension::c_size, DBG, malformed_expr, libdap::Array::dimension::size, libdap::Array::dimension::start, libdap::Array::dimension::stop, libdap::Array::dimension::stride, and update_length().

Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), libdap::ArrayGeoConstraint::apply_constraint_to_data(), and libdap::GeoConstraint::reorder_data_longitude_axis().

Here is the call graph for this function:

void libdap::Array::add_var ( BaseType v,
Part  p = nil 
) [virtual]

Propagate the name of the BaseType instance to this instance. This ensures that variables at any given level of the DDS table have unique names (i.e., that Arrays do not have their default name ""). If v's name is null, then assume that the array is named and don't overwrite it with v's null name.

Note:
This version checks to see if v is an array. If so, it calls Vector::add_var() using the template variable of v and then appends the dimensions of v to this array. This somewhat obscure behavior simplifies 'translating' Sequences to arrays when the actual variable being translated is not a regular Sequence but an array of Sequences.
Parameters:
vThe template variable for the array
pThe Part parameter defaults to nil and is ignored by this method.

Reimplemented from libdap::Vector.

Definition at line 176 of file Array.cc.

References append_dim(), dim_begin(), dim_end(), dimension_name(), dimension_size(), libdap::dods_array_c, libdap::BaseType::type(), and libdap::Vector::var().

Referenced by Array(), and libdap::function_linear_scale().

Here is the call graph for this function:

void libdap::Array::append_dim ( int  size,
string  name = "" 
)

Given a size and a name, this function adds a dimension to the array. For example, if the Array is already 10 elements long, calling append_dim with a size of 5 will transform the array into a 10x5 matrix. Calling it again with a size of 2 will create a 10x5x2 array, and so on. This sets Vector's length member as a side effect.

Parameters:
sizeThe size of the desired new row.
nameThe name of the new dimension. This defaults to an empty string.

Definition at line 205 of file Array.cc.

References libdap::Array::dimension::c_size, libdap::Array::dimension::name, libdap::Array::dimension::size, libdap::Array::dimension::start, libdap::Array::dimension::stop, libdap::Array::dimension::stride, update_length(), and libdap::www2id().

Referenced by add_var().

Here is the call graph for this function:

unsigned int libdap::Vector::buf2val ( void **  val) [virtual, inherited]

Copies data from the Vector buffer. This function assumes that val points to an array large enough to hold N instances of the `C' representation of the numeric element type or C++ string objects. Never call this method for constructor types Structure, Sequence or Grid.

When reading data out of a variable that has been constrained, this method assumes the N values/bytes of constrained data start at the beginning of the object's internal buffer. For example, do not load an entire Vector's data using val2buf(), constrain and then use this method to get the data. Unless your constraint starts with the [0]th element, the result will not be the correct values.

In the case of a Vector of Str objects, this method will return an array of C++ std::string objects.

Note:
It's best to define the pointer to reference the data as 'char *data' and then call this method using '..->buf2val((void**)&data)'. Then free the storage once you're done using 'delete[] data'. It's not correct C++ to use 'delete[]' on a void pointer and the allocated memory is an array of char, so 'delete[]' is needed.
Returns:
The number of bytes used to store the array.
Parameters:
valA pointer to a pointer to the memory into which the class data will be copied. If the value pointed to is NULL, memory will be allocated to hold the data, and the pointer value modified accordingly. The calling program is responsible for deallocating the memory indicated by this pointer.
Exceptions:
InternalErrThrown if val is null.
See also:
Vector::set_vec

Implements libdap::BaseType.

Definition at line 935 of file Vector.cc.

References libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_str_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::BaseType::type(), and libdap::Vector::width().

Here is the call graph for this function:

bool libdap::Array::check_semantics ( string &  msg,
bool  all = false 
) [virtual]

This function checks semantic features of the Array. Currently, the only check specific to the Array is that there must be dimensions. The rest is inherited from BaseType::check_semantics().

Returns:
A boolean value. FALSE means there was a problem.

Reimplemented from libdap::Vector.

Definition at line 869 of file Array.cc.

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

Tell the Array object to clear the constraint information about dimensions. Do this once before calling add_constraint() for each new constraint expression. Only the dimensions explicitly selected using add_constraint() will be sent.

Deprecated:
This should never be used.

Definition at line 282 of file Array.cc.

References reset_constraint().

Referenced by libdap::Grid::clear_constraint().

Here is the call graph for this function:

void libdap::Vector::clear_local_data ( ) [inherited]

Remove any read or set data in the private data of this Vector, setting read_p() to false. Essentially clears the _buf, d_str, and _vec of any data. Useful for tightening up memory when the data is no longer needed, but the object cannot yet be destroyed. NOTE: this is not virtual, and only affects the data in Vector itself! On exit: get_value_capacity() == 0 && !read_p()

Definition at line 1039 of file Vector.cc.

References libdap::Vector::set_read_p().

Referenced by libdap::Vector::~Vector().

Here is the call graph for this function:

unsigned int libdap::Vector::create_cardinal_data_buffer_for_type ( unsigned int  numEltsOfType) [protected, inherited]

Create _buf so that it can store numElts of the (assumed) cardinal type. This create storage for width() * numElts bytes. If _buf already exists, this DELETES IT and creates a new one. So don't use this if you want to keep the original _buf data around. This also sets the valueCapacity().

Parameters:
numEltsthe number of elements of the cardinal type in var() that we want storage for.
Returns:
the size of the buffer created.
Exceptions:
ifthe Vector's type is not cardinal type.

Definition at line 159 of file Vector.cc.

References libdap::Vector::delete_cardinal_data_buffer(), libdap::Vector::is_cardinal_type(), and libdap::BaseType::width().

Referenced by libdap::Vector::deserialize(), libdap::Vector::reserve_value_capacity(), libdap::Vector::set_cardinal_values_internal(), and libdap::Vector::val2buf().

Here is the call graph for this function:

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(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().

void libdap::Vector::delete_cardinal_data_buffer ( ) [protected, inherited]

Delete _buf and zero it and _capacity out

Definition at line 192 of file Vector.cc.

Referenced by libdap::Vector::create_cardinal_data_buffer_for_type(), libdap::Vector::deserialize(), and libdap::Vector::val2buf().

bool libdap::Vector::deserialize ( UnMarshaller um,
DDS dds,
bool  reuse = false 
) [virtual, inherited]

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:
umAn UnMarshaller that knows how to deserialize data types
ddsThe 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.
reuseA 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:
Errorwhen a problem reading from the UnMarshaller is found.
See also:
DDS

Implements libdap::BaseType.

Definition at line 724 of file Vector.cc.

References libdap::Vector::create_cardinal_data_buffer_for_type(), DBG, libdap::Vector::delete_cardinal_data_buffer(), 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_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::UnMarshaller::get_int(), libdap::UnMarshaller::get_str(), libdap::UnMarshaller::get_vector(), libdap::Vector::length(), libdap::BaseType::ptr_duplicate(), libdap::Vector::set_length(), libdap::BaseType::type(), libdap::BaseType::type_name(), libdap::Vector::vec_resize(), libdap::BaseType::width(), and libdap::Vector::width().

Here is the call graph for this function:

Array::Dim_iter libdap::Array::dim_begin ( )
Array::Dim_iter libdap::Array::dim_end ( )

Returns an iterator past the last dimension of the Array.

Definition at line 347 of file Array.cc.

Referenced by add_var(), print_xml_core(), and libdap::Grid::projection_yields_grid().

string libdap::Array::dimension_name ( Dim_iter  i) [virtual]

This function returns the name of the dimension indicated with p. Since this method is public, it is possible to call it before the Array object has been properly initialized. This will cause an exception. So don't do that.

Parameters:
iThe dimension.
Returns:
A pointer to a string containing the dimension name.

Definition at line 488 of file Array.cc.

Referenced by add_var().

int libdap::Array::dimension_size ( Dim_iter  i,
bool  constrained = false 
) [virtual]

Return the size of the array dimension referred to by i. If the dimension is constrained the constrained size is returned if constrained is true.

Parameters:
iThe dimension.
constrainedIf this parameter is TRUE, the method returns the constrained size of the array so long as a constraint has been applied to this dimension. If TRUE and no constraint has been applied, this method returns zero. If it is FALSE, the method ignores any constraint that has been applied to this dimension and returns the full size of the dimension. The default value is FALSE.
Returns:
An integer containing the size of the specified dimension.

Definition at line 390 of file Array.cc.

Referenced by add_var(), libdap::Grid::check_semantics(), print_val(), and libdap::Grid::projection_yields_grid().

int libdap::Array::dimension_start ( Dim_iter  i,
bool  constrained = false 
) [virtual]

Use this function to return the start index of an array dimension. If the array is constrained (indicated with the constrained argument), the start index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_stop() and dimension_stride().

Parameters:
iThe dimension.
constrainedIf this parameter is TRUE, the function returns the start index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the start index whether or not the dimension is constrained.
Returns:
The desired start index.

Definition at line 423 of file Array.cc.

Referenced by libdap::GSEClause::GSEClause(), and libdap::Grid::projection_yields_grid().

int libdap::Array::dimension_stop ( Dim_iter  i,
bool  constrained = false 
) [virtual]

Use this function to return the stop index of an array dimension. If the array is constrained (indicated with the constrained argument), the stop index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_start() and dimension_stride().

Parameters:
iThe dimension.
constrainedIf this parameter is TRUE, the function returns the stop index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stop index whether or not the dimension is constrained.
Returns:
The desired stop index.

Definition at line 447 of file Array.cc.

Referenced by libdap::GSEClause::GSEClause(), and libdap::Grid::projection_yields_grid().

int libdap::Array::dimension_stride ( Dim_iter  i,
bool  constrained = false 
) [virtual]

Use this function to return the stride value of an array dimension. If the array is constrained (indicated with the constrained argument), the stride value of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_stop() and dimension_start().

Parameters:
iThe dimension.
constrainedIf this parameter is TRUE, the function returns the stride value only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stride value whether or not the dimension is constrained.
Returns:
The stride value requested, or zero, if constrained is TRUE and the dimension is not selected.

Definition at line 472 of file Array.cc.

Referenced by libdap::Grid::projection_yields_grid().

unsigned int libdap::Array::dimensions ( bool  constrained = false) [virtual]

Return the total number of dimensions contained in the array. When constrained is TRUE, return the number of dimensions given the most recently evaluated constraint expression.

Parameters:
constrainedA boolean flag to indicate whether the array is constrained or not. Ignored.

Definition at line 362 of file Array.cc.

Referenced by libdap::Grid::check_semantics(), libdap::GridGeoConstraint::GridGeoConstraint(), and print_val().

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

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

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

Reimplemented from libdap::Vector.

Definition at line 888 of file Array.cc.

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

Here is the call graph for this function:

int libdap::Vector::element_count ( bool  leaves) [virtual, inherited]

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:
leavesThis 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 326 of file Vector.cc.

References libdap::BaseType::element_count(), and libdap::Vector::var().

Referenced by libdap::Grid::element_count().

Here is the call graph for this function:

AttrTable & libdap::BaseType::get_attr_table ( ) [virtual, inherited]

Get this variable's AttrTable. It's generally a bad idea to return a reference to a contained object, but in this case it seems that building an interface inside BaseType is overkill.

Use the AttrTable methods to manipulate the table.

Definition at line 531 of file BaseType.cc.

Referenced by libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), print_xml_core(), libdap::Grid::transfer_attributes(), libdap::Constructor::transfer_attributes(), and libdap::BaseType::transfer_attributes().

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 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().

unsigned int libdap::Vector::get_value_capacity ( ) const [virtual, inherited]

Return the capacity of the Vector in terms of number of elements of its data type that it CAN currently hold (i.e. not bytes). For example, this could be the size of the _buf array in bytes / sizeof(T) for the cardinal types T, or the capacity of the d_str vector if T is string or url type.

Definition at line 1068 of file Vector.cc.

Referenced by libdap::Vector::set_value_slice_from_row_major_vector().

void libdap::Vector::intern_data ( ConstraintEvaluator eval,
DDS dds 
) [virtual, inherited]

Most uses of a variable are to either serialize its data to a stream of some sort or to read values from some stream and intern those in the variable for later use. These operations are perform by serialize() and deserialize() which follow. This function performs essentially both of these operations without actually using a stream device. The data are read using the read() method(s) and loaded into the variables directly.

This method is intended to be used by objects which transform DAP objects like the DataDDS into an ASCII CSV representation.

the data source.

Parameters:
evalA reference to a constraint evaluator
ddsThe complete DDS to which this variable belongs

Reimplemented from libdap::BaseType.

Definition at line 570 of file Vector.cc.

References DBG, 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_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::Vector::length(), libdap::BaseType::name(), libdap::BaseType::read(), libdap::BaseType::read_p(), and libdap::BaseType::type().

Here is the call graph for this function:

bool libdap::Vector::is_cardinal_type ( ) const [protected, 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 610 of file BaseType.cc.

bool libdap::BaseType::is_simple_type ( ) [virtual, inherited]
int libdap::Vector::length ( ) const [virtual, inherited]
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(), libdap::Grid::check_semantics(), libdap::Sequence::deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), libdap::GSEClause::get_map_name(), libdap::GridGeoConstraint::GridGeoConstraint(), libdap::GSEClause::GSEClause(), libdap::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(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), 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(), libdap::Grid::transfer_attributes(), libdap::Constructor::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::rvalue::value_name(), libdap::Vector::var(), libdap::Structure::var(), libdap::Sequence::var(), libdap::Grid::var(), and libdap::Sequence::var_value().

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

Definition at line 144 of file Array.cc.

References _duplicate().

Here is the call graph for this function:

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.

Parameters:
bCompare the value of this instance with b.
opAn integer index indicating which relational operator is implied. Choose one from the following: EQUAL, NOT_EQUAL, GREATER, GREATER_EQL, LESS, LESS_EQL, and REGEXP.
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 1081 of file BaseType.cc.

Referenced by libdap::Clause::value().

void libdap::Array::prepend_dim ( int  size,
const string &  name = "" 
)

Creates a new OUTER dimension (slowest varying in rowmajor) for the array by prepending rather than appending it.

Parameters:
sizecardinality of the new dimension
nameoptional name for the new dimension

Definition at line 230 of file Array.cc.

References libdap::Array::dimension::c_size, libdap::Array::dimension::name, libdap::Array::dimension::size, libdap::Array::dimension::start, libdap::Array::dimension::stop, libdap::Array::dimension::stride, update_length(), and libdap::www2id().

Here is the call graph for this function:

unsigned int libdap::Array::print_array ( ostream &  out,
unsigned int  index,
unsigned int  dims,
unsigned int  shape[] 
) [protected]

Prints the values in ASCII of the entire (constrained) array. This method Attempts to make an anesthetically pleasing display. However, it is primarily intended for debugging purposes.

Parameters:
outWrite the output to this ostream
spaceThe space to use in printing.
print_decl_pA boolean value indicating whether you want the Array declaration to precede the Array value.

Definition at line 768 of file Array.cc.

References libdap::BaseType::print_val(), and libdap::Vector::var().

Referenced by print_val().

Here is the call graph for this function:

void libdap::Array::print_as_map_xml ( ostream &  out,
string  space = "    ",
bool  constrained = false 
) [virtual]

Definition at line 612 of file Array.cc.

References print_xml_core().

Here is the call graph for this function:

void libdap::Array::print_decl ( ostream &  out,
string  space = "    ",
bool  print_semi = true,
bool  constraint_info = false,
bool  constrained = false 
) [virtual]

Prints a declaration for the Array. This is what appears in a DDS. If the Array is constrained, the declaration will reflect the size of the Array once the constraint is applied.

Parameters:
outWrite the output to this ostream.
spaceA string containing spaces to precede the declaration.
print_semiA boolean indicating whether to print a semi-colon after the declaration. (TRUE means ``print a semi-colon.'')
constraint_infoA boolean value. See BaseType::print_decl().
constrainedThis argument should be TRUE if the Array is constrained, and FALSE otherwise.

Reimplemented from libdap::BaseType.

Definition at line 566 of file Array.cc.

References libdap::id2www(), libdap::BaseType::print_decl(), libdap::BaseType::send_p(), and libdap::Vector::var().

Referenced by print_val().

Here is the call graph for this function:

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

Parameters:
outThe output ostream on which to print the value.
spaceThis value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_pA boolean value controlling whether the variable declaration is printed as well as the value.

Implements libdap::BaseType.

Definition at line 832 of file Array.cc.

References dimension_size(), dimensions(), print_array(), and print_decl().

Referenced by libdap::GeoConstraint::reorder_data_longitude_axis().

Here is the call graph for this function:

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

Parameters:
outDestination output stream
spaceUse this to indent child declarations. Default is "".
constrainedIf true, only print this if it's part part of the current projection. Default is False.

Reimplemented from libdap::BaseType.

Definition at line 600 of file Array.cc.

References print_xml_core().

Referenced by libdap::Grid::print_xml().

Here is the call graph for this function:

void libdap::Array::print_xml_core ( ostream &  out,
string  space,
bool  constrained,
string  tag 
) [virtual]
BaseType * libdap::Array::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 libdap::Vector.

Definition at line 138 of file Array.cc.

References Array().

Referenced by libdap::Grid::add_map(), libdap::Grid::add_var(), and libdap::Grid::prepend_map().

Here is the call graph for this function:

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() should throw Error if it encounters an error. The message should be verbose enough to be understood by someone running a client on a different machine.
  • The value(s) should be read if and only if either send_p() or is_in_selection() return true. If neither of these return true, the value(s) should not be read. This is important when writing read() for a Constructor type such as Grid where a client may ask for only the map vectors (and thus reading the much larger Array part is not needed).
  • For each specialization of read(), the method should first test the value of the 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.
  • The Array::read() and Grid::read() methods should take into account any restrictions on Array sizes.
  • If you are writing Sequence::read(), be sure to check the documentation for Sequence::read_row() and Sequence::serialize() so you understand how Sequence::read() is being called.
  • 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().

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()).
See also:
BaseType
Sequence

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(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), 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(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().

bool libdap::BaseType::read_p ( ) [virtual, inherited]
void libdap::Vector::reserve_value_capacity ( unsigned int  numElements) [virtual, inherited]

Allocate enough memory for the Vector to contain numElements data elements of the Vector's type. Must be used before set_value_slice_from_row_major_vector to ensure memory exists.

Parameters:
numElementsthe number of elements of the Vector's type to preallocate storage for.
Exceptions:
ifthe memory cannot be allocated

Definition at line 1084 of file Vector.cc.

References libdap::Vector::create_cardinal_data_buffer_for_type(), 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_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().

Here is the call graph for this function:

void libdap::Vector::reserve_value_capacity ( ) [virtual, inherited]

Make sure there's storage allocated for the current length() of the Vector. Same as reserveValueCapacity(length())

Definition at line 1138 of file Vector.cc.

References libdap::Vector::length().

Here is the call graph for this function:

void libdap::Array::reset_constraint ( ) [virtual]

Resets the dimension constraint information so that the entire array is selected.

Definition at line 257 of file Array.cc.

References libdap::Vector::set_length(), and update_length().

Referenced by clear_constraint().

Here is the call graph for this function:

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.

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

Definition at line 503 of file BaseType.cc.

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

bool libdap::Vector::serialize ( ConstraintEvaluator eval,
DDS dds,
Marshaller m,
bool  ce_eval = true 
) [virtual, inherited]

This uses the Marshaler class to encode each element of a cardinal array. For Arrays of Str and Url types, send the element count over as a prefix to the data so that deserialize will know how many elements to read.

NB: Arrays of cardinal types must already be in BUF (in the local machine's representation) before this call is made.

Implements libdap::BaseType.

Definition at line 636 of file Vector.cc.

References libdap::BaseType::dataset(), 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_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::ConstraintEvaluator::eval_selection(), libdap::Vector::length(), libdap::Marshaller::put_int(), libdap::Marshaller::put_str(), libdap::Marshaller::put_vector(), libdap::BaseType::read(), libdap::BaseType::read_p(), libdap::DDS::timeout_off(), libdap::DDS::timeout_on(), libdap::BaseType::type(), and libdap::BaseType::width().

Here is the call graph for this function:

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

Set this variable's attribute table.

Parameters:
atSource of the attributes.

Definition at line 539 of file BaseType.cc.

template<class CardType >
void libdap::Vector::set_cardinal_values_internal ( const CardType *  fromArray,
int  numElts 
) [protected, inherited]

Helper to reduce cut and paste in the virtual's.

Definition at line 206 of file Vector.cc.

References libdap::Vector::create_cardinal_data_buffer_for_type(), libdap::Vector::set_length(), and libdap::Vector::set_read_p().

Here is the call graph for this function:

void libdap::BaseType::set_in_selection ( bool  state) [virtual, inherited]

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:
stateSet the in_selection property to this state.
See also:
BaseType::read()
BaseType::is_in_selection() for more information.

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

Definition at line 625 of file BaseType.cc.

Referenced by libdap::Grid::set_in_selection().

void libdap::Vector::set_length ( int  l) [virtual, inherited]

Sets the length of the vector. This function does not allocate any new space.

Definition at line 535 of file Vector.cc.

Referenced by libdap::Vector::deserialize(), reset_constraint(), libdap::Vector::set_cardinal_values_internal(), and libdap::Vector::set_value().

void libdap::Vector::set_name ( const std::string &  name) [virtual, inherited]

Definition at line 316 of file Vector.cc.

References libdap::BaseType::set_name().

Referenced by libdap::Vector::add_var().

Here is the call graph for this function:

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(), print_xml_core(), and libdap::Vector::set_name().

Here is the call graph for this function:

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

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

Parameters:
parentPointer to the Constructor of Vector parent variable.
Exceptions:
InternalErrthrown 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(), libdap::Grid::_duplicate(), libdap::Grid::add_map(), libdap::Vector::add_var(), libdap::Structure::add_var(), libdap::Sequence::add_var(), libdap::Grid::add_var(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().

void libdap::Vector::set_read_p ( bool  state) [virtual, inherited]

This function sets the read_p flag for both the Vector itself and its element template. This does not matter much when the Vector contains simple data types, but does become significant when the Vector contains compound types.

Reimplemented from libdap::BaseType.

Definition at line 358 of file Vector.cc.

References libdap::BaseType::set_read_p().

Referenced by libdap::ArrayGeoConstraint::apply_constraint_to_data(), libdap::Vector::clear_local_data(), libdap::function_geogrid(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::set_array_using_double(), libdap::Vector::set_cardinal_values_internal(), and libdap::Vector::set_value().

Here is the call graph for this function:

void libdap::Vector::set_send_p ( bool  state) [virtual, inherited]

This function sets the send_p flag for both the Vector itself and its element template. This does not matter much when the Vector contains simple data types, but does become significant when the Vector contains compound types.

Reimplemented from libdap::BaseType.

Definition at line 346 of file Vector.cc.

References libdap::BaseType::set_send_p().

Referenced by libdap::function_grid(), and libdap::function_linear_scale().

Here is the call graph for this function:

void libdap::BaseType::set_synthesized_p ( bool  state) [virtual, inherited]

Set the synthesized flag. Before setting this flag be sure to set the read_p() state. Once this flag is set you cannot alter the state of the read_p flag!

See also:
synthesized_p()

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::Vector::set_value ( vector< dods_float32 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1385 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_float64 val,
int  sz 
) [virtual, inherited]

Definition at line 1392 of file Vector.cc.

References libdap::dods_float64_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_uint16 val,
int  sz 
) [virtual, inherited]

Definition at line 1332 of file Vector.cc.

References libdap::dods_uint16_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_byte > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1285 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_int32 val,
int  sz 
) [virtual, inherited]

Definition at line 1312 of file Vector.cc.

References libdap::dods_int32_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_uint32 val,
int  sz 
) [virtual, inherited]

Definition at line 1352 of file Vector.cc.

References libdap::dods_uint32_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_float32 val,
int  sz 
) [virtual, inherited]

Definition at line 1372 of file Vector.cc.

References libdap::dods_float32_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_float64 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1405 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_byte val,
int  sz 
) [virtual, inherited]

Definition at line 1272 of file Vector.cc.

References libdap::dods_byte_c, libdap::BaseType::type(), and libdap::Vector::var().

Referenced by libdap::function_linear_scale(), and libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_uint32 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1365 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_int32 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1325 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_uint16 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1345 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< string > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1431 of file Vector.cc.

References libdap::dods_str_c, libdap::dods_url_c, libdap::Vector::set_length(), libdap::Vector::set_read_p(), libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( dods_int16 val,
int  sz 
) [virtual, inherited]

Definition at line 1292 of file Vector.cc.

References libdap::dods_int16_c, libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

bool libdap::Vector::set_value ( vector< dods_int16 > &  val,
int  sz 
) [virtual, inherited]

Definition at line 1305 of file Vector.cc.

References libdap::Vector::set_value().

Here is the call graph for this function:

bool libdap::Vector::set_value ( string *  val,
int  sz 
) [virtual, inherited]

Definition at line 1412 of file Vector.cc.

References libdap::dods_str_c, libdap::dods_url_c, libdap::Vector::set_length(), libdap::Vector::set_read_p(), libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

unsigned int libdap::Vector::set_value_slice_from_row_major_vector ( const Vector rowMajorDataC,
unsigned int  startElement 
) [virtual, inherited]

Copy rowMajorData.length() elements currently in a rowMajorData buffer into this value buffer starting at element index startElement and continuing up to startElement+rowMajorData.length()-1

This is used for aggregating together smaller rowMajor vectors into a larger one.

Note: unlike the other set_value calls, this does NOT set read_p() since it is assumed to be used as a partial read and the caller is expected to set_read_p() when the data is complete.

ASSUMES: rowMajorData.read_p() so that the data is valid! ASSUMES: this Vector has enough value_capacity() to contain all the elements such that: startElement + rowMajorData.length() <= this->value_capacity(). ASSUMES: the data type of this->var() and rowMajorData.var() MUST be non-NULL and be the same!

Parameters:
rowMajorDatathe vector from which to copy data, assumed already read in or set.
startElementthe element index (NOT byte, but rather data type element) to place the first data value.
Returns:
the number of elements added, such that: startElement + the return value is the next "free" element.

Definition at line 1173 of file Vector.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_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::Vector::get_value_capacity(), libdap::Vector::length(), libdap::BaseType::read_p(), libdap::BaseType::type(), libdap::Vector::var(), libdap::Vector::width(), and libdap::BaseType::width().

Here is the call graph for this function:

void libdap::Vector::set_vec ( unsigned int  i,
BaseType val 
) [inherited]

Sets an element of the vector to a given value. If the type of the input and the type of the Vector do not match, an error condition is returned.

Use this function only with Vectors containing compound DAP2 types. See buf2val() to access members of Vectors containing simple types.

Note:
This method copies val; the caller is responsible for deleting instance passed as the actual parameter.
Returns:
void
Exceptions:
InternalErrThrown if i is out of range, val is null or there was a type mismatch between the BaseType referenced by val and the ith element of this Vector.
Parameters:
iThe index of the element to be changed.
valA pointer to the value to be inserted into the array.
See also:
Vector::buf2val

Definition at line 1007 of file Vector.cc.

References libdap::BaseType::ptr_duplicate(), libdap::BaseType::type(), and libdap::Vector::vec_resize().

Here is the call graph for this function:

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.

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

Reimplemented in libdap::Sequence.

Definition at line 161 of file BaseType.cc.

References libdap::BaseType::type_name().

Referenced by libdap::GSEClause::GSEClause().

Here is the call graph for this function:

void libdap::BaseType::transfer_attributes ( AttrTable at_container) [virtual, inherited]

Transfer attributes from a DAS object into this variable. Because of the rough history of the DAS object and the way that various server code built the DAS, this is necessarily a heuristic process. The intent is that this method will be overridden by handlers that need to look for certain patterns in the DAS (e.g., hdf4's odd variable_dim_n; where n = 0, 1, 2, ...) attribute containers.

There should be a one-to-one mapping between variables and attribute containers. However, in some cases one variable has attributes spread across several top level containers and in some cases one container is used by several variables

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:
dasA pointer to the DAS object for the entire dataset.
Returns:
void

Reimplemented in libdap::Constructor, and libdap::Grid.

Definition at line 571 of file BaseType.cc.

References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), DBG, 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::BaseType::name(), and libdap::AttrTable::set_is_global_attribute().

Referenced by libdap::Grid::transfer_attributes().

Here is the call graph for this function:

void libdap::Array::update_length ( int  size) [virtual]
Deprecated:
Calling this method should never be necessary. It is called whenever the size of the Array is changed.

Changes the size property of the array. If the array exists, it is augmented by a factor of size. This does not change the actual size of the array.

Definition at line 72 of file Array.cc.

Referenced by add_constraint(), append_dim(), prepend_dim(), and reset_constraint().

unsigned int libdap::Vector::val2buf ( void *  val,
bool  reuse = false 
) [virtual, inherited]

Copies data into the class instance buffer. This function assumes that the input val points to memory which contains, in row major order, enough elements of the correct type to fill the array. For an array of a cardinal type the memory is simply copied in whole into the Vector buffer.

If the variable has already been constrained, this method will load only number of values/bytes specified by that constraint and will load them into the 'front' of the object's internal buffer. This is where serialize() expects to find the data.

For a Vector of Str (OPeNDAP Strings), this assumes val points to an array of C++ strings.

This method should not be used for Structure, Sequence or Grid.

Returns:
The number of bytes used by the array.
Parameters:
valA pointer to the input data.
reuseA 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.

Implements libdap::BaseType.

Definition at line 848 of file Vector.cc.

References libdap::Vector::create_cardinal_data_buffer_for_type(), libdap::Vector::delete_cardinal_data_buffer(), libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_str_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::Vector::length(), libdap::BaseType::type(), and libdap::Vector::width().

Referenced by libdap::Vector::_duplicate(), libdap::GridGeoConstraint::apply_constraint_to_data(), libdap::ArrayGeoConstraint::apply_constraint_to_data(), and libdap::function_linear_scale().

Here is the call graph for this function:

void * libdap::Vector::value ( ) [virtual, inherited]

Allocated memory and copy data into the new buffer. Return the new buffer's pointer. The caller must delete the storage.

Definition at line 1521 of file Vector.cc.

References libdap::Vector::width().

Here is the call graph for this function:

void libdap::Vector::value ( dods_uint16 b) const [virtual, inherited]

Definition at line 1465 of file Vector.cc.

References libdap::dods_uint16_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( dods_int16 b) const [virtual, inherited]

Definition at line 1473 of file Vector.cc.

References libdap::dods_int16_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( vector< string > &  b) const [virtual, inherited]

Definition at line 1513 of file Vector.cc.

References libdap::dods_byte_c, libdap::dods_url_c, and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( dods_int32 b) const [virtual, inherited]

Definition at line 1489 of file Vector.cc.

References libdap::dods_int32_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( dods_uint32 b) const [virtual, inherited]

Definition at line 1481 of file Vector.cc.

References libdap::dods_uint32_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( dods_float32 b) const [virtual, inherited]

Definition at line 1497 of file Vector.cc.

References libdap::dods_float32_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::Vector::value ( dods_byte b) const [virtual, inherited]
Parameters:
bA pointer to the memory to hold the data; must be at least length() * sizeof(dods_byte) in size.

Definition at line 1457 of file Vector.cc.

References libdap::dods_byte_c, libdap::Vector::length(), and libdap::BaseType::type().

Referenced by libdap::GeoConstraint::flip_latitude_within_array(), and libdap::GeoConstraint::reorder_data_longitude_axis().

Here is the call graph for this function:

void libdap::Vector::value ( dods_float64 b) const [virtual, inherited]

Definition at line 1505 of file Vector.cc.

References libdap::dods_float64_c, libdap::Vector::length(), and libdap::BaseType::type().

Here is the call graph for this function:

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

Returns a copy of the template array element. If the Vector contains simple data types, the template will contain the value of the last vector element accessed with the Vector::var(int i) function, if any. If no such access has been made, or if the Vector contains compound data types, the value held by the template instance is undefined.

Note that the parameter exact_match is not used by this mfunc.

Parameters:
nThe name of the variable to find.
exactUnused.
sPointer to a BaseType Pointer Stack. Use this stack to record the path to the variable. By default this pointer is null, in which case it is not used.
Returns:
A pointer to the BaseType if found, otherwise null.
See also:
Vector::var

Reimplemented from libdap::BaseType.

Definition at line 383 of file Vector.cc.

References DBG, libdap::BaseType::is_constructor_type(), libdap::BaseType::name(), libdap::BaseType::var(), and libdap::www2id().

Referenced by add_var(), libdap::Grid::check_semantics(), libdap::Vector::element_count(), libdap::extract_double_array(), libdap::GeoConstraint::flip_latitude_within_array(), libdap::XDRStreamUnMarshaller::get_vector(), libdap::XDRFileUnMarshaller::get_vector(), print_array(), print_decl(), print_xml_core(), libdap::XDRStreamMarshaller::put_vector(), libdap::XDRFileMarshaller::put_vector(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::set_array_using_double(), libdap::Vector::set_value(), and libdap::Vector::set_value_slice_from_row_major_vector().

Here is the call graph for this function:

BaseType * libdap::Vector::var ( const string &  n,
btp_stack s 
) [virtual, inherited]

This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as above 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.

Parameters:
nFind the variable whose name is name.
sRecord the path to name.
Returns:
A pointer to the named variable.

Reimplemented from libdap::BaseType.

Definition at line 418 of file Vector.cc.

References libdap::BaseType::is_constructor_type(), libdap::BaseType::name(), libdap::BaseType::var(), and libdap::www2id().

Here is the call graph for this function:

BaseType * libdap::Vector::var ( unsigned int  i) [virtual, inherited]

Returns a pointer to the specified Vector element. The return pointer will reference the element itself, so multiple calls to this method should save each value before making the next call.

Todo:
Is this method thread safe? If 'apartment threading' is used, I think so. But if the library is running in more than one thread, then this is not thread safe.
Parameters:
iThe index of the desired Vector element. Zero indicates the first element of the Vector.
Returns:
A pointer to a BaseType class instance containing the value of the indicated element. The BaseType pointer is locally maintained and should not be deleted or referenced. Extract the value right after the method returns.
See also:
BaseType::var

Definition at line 454 of file Vector.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_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, libdap::BaseType::type(), libdap::BaseType::val2buf(), and libdap::BaseType::width().

Here is the call graph for this function:

void libdap::Vector::vec_resize ( int  l) [inherited]

Resizes a Vector. If the input length is greater than the current length of the Vector, new memory is allocated (the Vector moved if necessary), and the new entries are appended to the end of the array and padded with Null values. If the input length is shorter, the tail values are discarded.

Definition at line 548 of file Vector.cc.

Referenced by libdap::Vector::deserialize(), and libdap::Vector::set_vec().

unsigned int libdap::Vector::width ( ) [virtual, inherited]

Returns the number of bytes needed to hold the entire array. This is equal to length() times the width of each element.

Implements libdap::BaseType.

Definition at line 507 of file Vector.cc.

References libdap::Vector::length(), and libdap::BaseType::width().

Referenced by libdap::Vector::buf2val(), libdap::Vector::deserialize(), libdap::GeoConstraint::flip_latitude_within_array(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::Vector::set_value_slice_from_row_major_vector(), libdap::Vector::val2buf(), and libdap::Vector::value().

Here is the call graph for this function:


Friends And Related Function Documentation

friend class ArrayTest [friend]

Definition at line 127 of file Array.h.


The documentation for this class was generated from the following files: