libdap::Vector Class Reference

Holds a one-dimensional collection of DAP2 data types. More...

#include <Vector.h>

Inheritance diagram for libdap::Vector:

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

Collaboration graph
[legend]

List of all members.

Public Types

typedef stack< BaseType * > btp_stack

Public Member Functions

virtual void add_var (BaseType *v, Part p=nil)
 Add the BaseType pointer to this constructor type instance.
virtual unsigned int buf2val (void **val)
virtual bool check_semantics (string &msg, bool all=false)
 Compare an object's current state with the semantics of its type.
virtual bool deserialize (UnMarshaller &um, DDS *dds, bool reuse=false)
 Receive data from the net.
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int element_count (bool leaves)
 Count the members of constructor types.
virtual AttrTableget_attr_table ()
virtual BaseTypeget_parent ()
virtual void intern_data (const string &dataset, 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.
Vectoroperator= (const Vector &rhs)
virtual bool ops (BaseType *b, int op, const string &dataset)
 Evaluate relational operators.
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure.
virtual void print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure.
virtual void print_xml (ostream &out, string space=" ", bool constrained=false)
virtual void print_xml (FILE *out, string space=" ", bool constrained=false)
virtual BaseTypeptr_duplicate ()=0
virtual bool read (const string &dataset)
 Read data into a local buffer.
virtual bool read_p ()
 Has this variable been read?
virtual bool send_p ()
 Should this variable be sent?
virtual bool serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
 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 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.
void set_vec (unsigned int i, BaseType *val)
 Sets element i to value val.
virtual bool synthesized_p ()
virtual string toString ()
Type type () const
 Returns the type of the class instance.
string type_name () const
 Returns the type of the class instance as a string.
virtual unsigned int val2buf (void *val, bool reuse=false)
 Reads data into the Vector buffer.
Exceptions:
InternalErr Thrown if called for Structure, Sequence or Grid.

virtual BaseTypevar (const string &name, btp_stack &s)
virtual BaseTypevar (const string &name="", bool exact_match=true, btp_stack *s=0)
 Returns a pointer to a member of a constructor class.
virtual BaseTypevar (unsigned int i)
virtual BaseTypevar (const string &name, btp_stack &s)
virtual BaseTypevar (const string &name="", bool exact_match=true, btp_stack *s=0)
void vec_resize (int l)
 Vector (const Vector &rhs)
 Vector (const string &n="", BaseType *v=0, const Type &t=dods_null_c)
 The Vector constructor.
virtual unsigned int width ()
 Returns the width of the data, in bytes.
virtual ~Vector ()
Abstract Methods


virtual void print_val (ostream &out, string space="", bool print_decl_p=true)=0
 Prints the value of the variable.
virtual void print_val (FILE *out, string space="", bool print_decl_p=true)=0
 Prints the value of the variable.
virtual bool set_value (vector< string > &val, int sz)
 set the value of a string or url array
virtual bool set_value (string *val, int sz)
 set the value of a string or url array
virtual bool set_value (vector< dods_float64 > &val, int sz)
 set the value of a float64 array
virtual bool set_value (dods_float64 *val, int sz)
 set the value of a float64 array
virtual bool set_value (vector< dods_float32 > &val, int sz)
 set the value of a float32 array
virtual bool set_value (dods_float32 *val, int sz)
 set the value of a float32 array
virtual bool set_value (vector< dods_uint32 > &val, int sz)
 set the value of a uint32 array
virtual bool set_value (dods_uint32 *val, int sz)
 set the value of a uint32 array
virtual bool set_value (vector< dods_int32 > &val, int sz)
 set the value of a int32 array
virtual bool set_value (dods_int32 *val, int sz)
 set the value of a int32 array
virtual bool set_value (vector< dods_uint16 > &val, int sz)
 set the value of a uint16 array
virtual bool set_value (dods_uint16 *val, int sz)
 set the value of a uint16 array
virtual bool set_value (vector< dods_int16 > &val, int sz)
 set the value of a int16 array
virtual bool set_value (dods_int16 *val, int sz)
 set the value of a int16 array
virtual bool set_value (vector< dods_byte > &val, int sz)
 set the value of a byte array
virtual bool set_value (dods_byte *val, int sz)
 set the value of a byte array
virtual void * value ()
virtual void value (vector< string > &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 (dods_float32 *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_int32 *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_int16 *b) const
 Get a copy of the data held by this variable.
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.

Protected Member Functions

void _duplicate (const BaseType &bt)
 Perform a deep copy.
void _duplicate (const Vector &v)


Detailed Description

Holds a one-dimensional array of DAP2 data types. This class takes two forms, depending on whether the elements of the vector are themselves simple or compound objects. This class contains common functionality for the List and Array classes, and should rarely be used directly.

When each element of the class is a simple data type, the Vector is implemented as a simple array of C types, rather than as an array of BaseType data types. A single private ``template'' BaseType instance (_var) is used to hold information in common to all the members of the array. The template is also used as a container to pass values back and forth to an application program, as in var().

If the elements of the vector are themselves compound data types, the array is stored as a vector of BaseType pointers (see the libdap class BaseTypePtrVec). The template is still used to hold information in common to all the members of the array, but is not used to pass information to and from the application program.

See also:
BaseType

Array

Definition at line 78 of file Vector.h.


Member Typedef Documentation

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

Definition at line 211 of file BaseType.h.


Constructor & Destructor Documentation

libdap::Vector::Vector ( const string &  n = "",
BaseType v = 0,
const Type t = dods_null_c 
)

The Vector constructor requires the name of the variable to be created, and a pointer to an object of the type the Vector is to hold. The name may be omitted, which will create a nameless variable. The template object may not be omitted.

Parameters:
n A string containing the name of the variable to be created.
v A pointer to a variable of the type to be included in the Vector.
t The type of the resulting Vector object, from the Type enum list. There is no DAP2 Vector object, so all uses of this method will be from the List or Array classes. This defaults to dods_null_c.
See also:
Type

Definition at line 119 of file Vector.cc.

References add_var(), DBG2, and libdap::BaseType::set_parent().

Here is the call graph for this function:

libdap::Vector::Vector ( const Vector rhs  ) 

The Vector copy constructor.

Definition at line 131 of file Vector.cc.

References _duplicate(), and DBG2.

Here is the call graph for this function:

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

Definition at line 140 of file Vector.cc.

References DBG2.


Member Function Documentation

void libdap::BaseType::_duplicate ( const BaseType bt  )  [protected, inherited]

Perform a deep copy. Copies the values of bt into *this. Pointers are dereferenced and their values are copied into a newly allocated instance.

Parameters:
bt The source object.

Definition at line 66 of file BaseType.cc.

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

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

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

Definition at line 60 of file Vector.cc.

References _buf, _length, _var, _vec, d_str, libdap::BaseType::ptr_duplicate(), libdap::BaseType::set_parent(), and val2buf().

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

Here is the call graph for this function:

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

Parameters:
v The template variable for the array
p The Part parameter defaults to nil and is ignored by this method.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Array.

Definition at line 1226 of file Vector.cc.

References DBG, libdap::BaseType::name(), libdap::BaseType::ptr_duplicate(), libdap::BaseType::set_name(), libdap::BaseType::set_parent(), and libdap::BaseType::type_name().

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

Here is the call graph for this function:

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

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 begining 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:
val A 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:
InternalErr Thrown if val is null.
See also:
Vector::set_vec

Implements libdap::BaseType.

Definition at line 770 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 width().

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

Here is the call graph for this function:

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

This function checks the class instance for internal consistency. This is important to check for complex constructor classes. For BaseType, an object is semantically correct if it has both a non-null name and type.

For example, an Int32 instance would return FALSE if it had no name or no type defined. A Grid instance might return FALSE for more complex reasons, such as having Map arrays of the wrong size or shape.

This function is used by the DDS class, and will rarely, if ever, be explicitly called by a DODS application program. A variable must pass this test before it is sent, but there may be many other stages in a retrieve operation where it would fail.

Returns:
Returns FALSE when the current state violates some aspect of the type semantics, TRUE otherwise.
Parameters:
msg A returned string, containing a message indicating the source of any problem.
all For complex constructor types (Grid, Sequence, Structure), this flag indicates whether to check the semantics of the member variables, too.
See also:
DDS::check_semantics

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Array.

Definition at line 1260 of file Vector.cc.

References libdap::BaseType::check_semantics().

Here is the call graph for this function:

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

Receives data from the network connection identified by the source parameter. The data is put into the class data buffer according to the input dds.

This function is only used on the client side of the DODS client/server connection.

Parameters:
um An UnMarshaller that knows how to deserialize data types
dds The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. This would have been received from the server in an earlier transmission.
reuse A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is not reallocated. If FALSE, new storage is allocated. If the internal buffer has not been allocated at all, this argument has no effect.
Returns:
Always returns TRUE.
Exceptions:
Error when a problem reading from the UnMarshaller is found.
See also:
DDS

Implements libdap::BaseType.

Definition at line 557 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::UnMarshaller::get_int(), libdap::UnMarshaller::get_str(), libdap::UnMarshaller::get_vector(), length(), libdap::BaseType::ptr_duplicate(), set_length(), libdap::BaseType::type(), libdap::BaseType::type_name(), vec_resize(), libdap::BaseType::width(), and width().

Here is the call graph for this function:

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

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

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

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Array.

Definition at line 1274 of file Vector.cc.

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

Referenced by libdap::Array::dump().

Here is the call graph for this function:

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

Return a count of the total number of variables in this variable. This is used to count the number of variables held by a constructor variable - for simple type and vector variables it always returns 1.

For compound data types, there are two ways to count members. You can count the members, or you can count the simple members and add that to the count of the compound members. For example, if a Structure contains an Int32 and another Structure that itself contains two Int32 members, the element count of the top-level structure could be two (one Int32 and one Structure) or three (one Int32 by itself and two Int32's in the subsidiary Structure). Use the leaves parameter to control which kind of counting you desire.

Returns:
Returns 1 for simple types. For compound members, the count depends on the leaves argument.
Parameters:
leaves This parameter is only relevant if the object contains other compound data types. If FALSE, the function counts only the data variables mentioned in the object's declaration. If TRUE, it counts the simple members, and adds that to the sum of the counts for the compound members. This parameter has no effect for simple type variables.

Reimplemented from libdap::BaseType.

Definition at line 173 of file Vector.cc.

References libdap::BaseType::element_count(), and 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 480 of file BaseType.cc.

Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::Array::print_xml_core().

BaseType * libdap::BaseType::get_parent (  )  [virtual, inherited]

Return a pointer to the Constructor or Vector which holds (contains) this variable. If this variable is at the top level, this method returns null.

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

Definition at line 550 of file BaseType.cc.

Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::function_linear_scale(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_two().

void libdap::Vector::intern_data ( const string &  dataset,
ConstraintEvaluator eval,
DDS dds 
) [virtual]

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.

Parameters:
dataset A string passed to read() so data values can be read from the data source.
eval A reference to a constraint evaluator
dds The complete DDS to which this variable belongs

Reimplemented from libdap::BaseType.

Definition at line 405 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, length(), libdap::BaseType::read(), libdap::BaseType::read_p(), and libdap::BaseType::type().

Here is the call graph for this function:

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

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

Does this variable appear in either the selection part or as a function argument in the current constrain expression. If this property is set (true) then implementations of the read() method should read this variable.

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

Definition at line 505 of file BaseType.cc.

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

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

int libdap::Vector::length (  )  const [virtual]

Returns the number of elements in the vector. Note that some child classes of Vector use the length of -1 as a flag value.

See also:
Vector::append_dim

Definition at line 359 of file Vector.cc.

Referenced by deserialize(), libdap::function_linear_scale(), intern_data(), libdap::GeoConstraint::reorder_data_longitude_axis(), serialize(), libdap::set_array_using_double(), libdap::Array::update_length(), value(), and width().

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

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

Definition at line 161 of file Vector.cc.

References _duplicate().

Here is the call graph for this function:

bool libdap::BaseType::ops ( BaseType b,
int  op,
const string &  dataset 
) [virtual, inherited]

This method contains the relational operators used by the constraint expression evaluator in the DDS class. Each class that wants to be able to evaluate relational expressions must overload this function. The implementation in BaseType throws an InternalErr exception. The DAP library classes Byte, ..., Url provide specializations of this method. It is not meaningful for classes such as Array because relational expressions using Array are not supported.

The op argument refers to a table generated by bison from the constraint expression parser. Use statements like the following to correctly interpret its value:

    switch (op) {
        case EQUAL: return i1 == i2;
        case NOT_EQUAL: return i1 != i2;
        case GREATER: return i1 > i2;
        case GREATER_EQL: return i1 >= i2;
        case LESS: return i1 < i2;
        case LESS_EQL: return i1 <= i2;
        case REGEXP: throw Error("Regular expressions are not supported for integer values");
        default: throw Error("Unknown operator");
    }
    

This function is used by the constraint expression evaluator.

Parameters:
b Compare the value of this instance with b.
op An integer index indicating which relational operator is implied. Choose one from the following: EQUAL, NOT_EQUAL, GREATER, GREATER_EQL, LESS, LESS_EQL, and REGEXP.
dataset The name of the dataset from which the instance's data has come (or is to come).
Returns:
The boolean value of the comparison.

Reimplemented in libdap::Byte, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Str, libdap::UInt16, and libdap::UInt32.

Definition at line 979 of file BaseType.cc.

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

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

Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.

A simple array declaration might look like this:

    Float64 lat[lat = 180];
    
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 in libdap::Array, libdap::Constructor, and libdap::Grid.

Definition at line 817 of file BaseType.cc.

References libdap::id2www(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().

Here is the call graph for this function:

void libdap::BaseType::print_decl ( FILE *  out,
string  space = "    ",