Vector Class Reference

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

#include <Vector.h>

Inheritance diagram for Vector:

Inheritance graph
[legend]
Collaboration diagram for Vector:

Collaboration graph
[legend]
List of all members.

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 (XDR *source, DDS *dds, bool reuse=false)
 Receive data from the net.
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int element_count (bool leaves)
 Count the members of constructor types.
virtual AttrTableget_attr_table ()
virtual BaseTypeget_parent ()
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 (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 (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, XDR *sink, 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.
virtual bool set_value (string *val, int sz)
 set the value of a string or url array
virtual bool set_value (dods_float64 *val, int sz)
 set the value of a float64 array
virtual bool set_value (dods_float32 *val, int sz)
 set the value of a float32 array
virtual bool set_value (dods_uint32 *val, int sz)
 set the value of a uint32 array
virtual bool set_value (dods_int32 *val, int sz)
 set the value of a int32 array
virtual bool set_value (dods_uint16 *val, int sz)
 set the value of a uint16 array
virtual bool set_value (dods_int16 *val, int sz)
 set the value of a int16 array
virtual bool set_value (dods_byte *val, int sz)
 set the value of a byte array
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 void value (vector< string > &b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_float64 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_float32 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_uint32 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_int32 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_uint16 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_int16 *b) const
 Get a copy of the pointer to the data held by this variable.
virtual void value (dods_byte *b) const
 Get a copy of the pointer to the data held by this variable.
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.
xdrproc_t xdr_coder ()
 Returns a function used to encode elements of an array.
virtual ~Vector ()
Abstract Methods
virtual void print_val (FILE *out, string space="", bool print_decl_p=true)=0
 Prints the value of the variable.

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 85 of file Vector.h.


Constructor & Destructor Documentation

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 116 of file Vector.cc.

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

Here is the call graph for this function:

Vector::Vector ( const Vector rhs  ) 

The Vector copy constructor.

Definition at line 128 of file Vector.cc.

References _duplicate(), and DBG2.

Here is the call graph for this function:

Vector::~Vector (  )  [virtual]

Definition at line 137 of file Vector.cc.

References DBG2.


Member Function Documentation

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

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

Parameters:
bt The source object.

Definition at line 64 of file BaseType.cc.

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

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

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

Definition at line 57 of file Vector.cc.

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

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

Here is the call graph for this function:

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

Reimplemented in Array.

Definition at line 1019 of file Vector.cc.

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

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

Here is the call graph for this function:

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

Definition at line 730 of file Vector.cc.

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

Referenced by GeoConstraint::reorder_data_longitude_axis().

Here is the call graph for this function:

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

Reimplemented in Array.

Definition at line 1049 of file Vector.cc.

References BaseType::check_semantics().

Here is the call graph for this function:

bool Vector::deserialize ( XDR *  source,
DDS dds,
bool  reuse = false 
) [virtual]

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

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

Parameters:
source A valid XDR pointer to the process connection to the net. This is generally created with a call to new_xdrstdio().
dds The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. This would have been received from the server in an earlier transmission.
reuse A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is not reallocated. If FALSE, new storage is allocated. If the internal buffer has not been allocated at all, this argument has no effect.
Returns:
Always returns TRUE.
Exceptions:
Error when a problem reading from the XDR stream is found.
See also:
DDS

Implements BaseType.

Definition at line 510 of file Vector.cc.

References DBG, dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, DODS_MAX_ARRAY, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, length(), BaseType::ptr_duplicate(), set_length(), BaseType::type(), BaseType::type_name(), vec_resize(), BaseType::width(), width(), BaseType::xdr_coder(), and xdr_str().

Here is the call graph for this function:

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

Reimplemented in Array.

Definition at line 1063 of file Vector.cc.

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

Referenced by Array::dump().

Here is the call graph for this function:

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

Definition at line 170 of file Vector.cc.

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

Referenced by Grid::element_count().

Here is the call graph for this function:

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

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

Use the AttrTable methods to manipulate the table.

Definition at line 480 of file BaseType.cc.

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

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

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

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

Definition at line 550 of file BaseType.cc.

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

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

Definition at line 307 of file BaseType.cc.

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

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

Here is the call graph for this function:

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

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

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

Definition at line 505 of file BaseType.cc.

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

Definition at line 250 of file BaseType.cc.

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

Referenced by Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().

Here is the call graph for this function:

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

Definition at line 277 of file BaseType.cc.

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

Referenced by DDXParser::ddx_end_element().

Here is the call graph for this function:

int 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 356 of file Vector.cc.

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

string BaseType::name (  )  const [inherited]

Definition at line 181 of file BaseType.cc.

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

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

Definition at line 158 of file Vector.cc.

References _duplicate().

Here is the call graph for this function:

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

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

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

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

This function is used by the constraint expression evaluator.

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

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

Definition at line 898 of file BaseType.cc.

Referenced by Clause::value().

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

Definition at line 762 of file BaseType.cc.

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

Referenced by DODSFilter::functional_constraint(), Grid::print_decl(), Array::print_decl(), UInt32::print_val(), UInt16::print_val(), Str::print_val(), Int32::print_val(), Int16::print_val(), Float64::print_val(), Float32::print_val(), and Byte::print_val().

Here is the call graph for this function:

virtual void BaseType::print_val ( FILE *  out,
string  space = "",
bool  print_decl_p = true 
) [pure virtual, inherited]

Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.

Parameters:
out The output FILE on which to print the value.
space This value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_p A boolean value controlling whether the variable declaration is printed as well as the value.

Implemented in Array, Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, and UInt32.

Referenced by Sequence::print_one_row(), and Grid::print_val().

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

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

Parameters:
out Destination.
space Use this to indent child declarations. Default is "".
constrained If true, only print this if it's part part of the current projection. Default is False.

Reimplemented in Array, Constructor, and Grid.

Definition at line 791 of file BaseType.cc.

References BaseType::get_attr_table(), id2xml(), AttrTable::print_xml(), BaseType::send_p(), and BaseType::type_name().

Referenced by Array::print_xml_core().

Here is the call graph for this function:

virtual BaseType* Vector::ptr_duplicate (  )  [pure virtual]

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

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

Implements BaseType.

Implemented in Array, and PassiveArray.

bool BaseType::read ( const string &  dataset  )  [virtual, inherited]

This method should be implemented for each of the data type classes (Byte, ..., Grid) when using the DAP class library to build a server. This method is only for DAP servers. The library provides a default definition here which throws an InternalErr exception unless the read_p property has been set. In that case it returns false, indicating that all the data have been read. The latter case can happen when building a constant value that needs to be passed to a function. The variable/constant is loaded with a value when it is created.

When implementing a new DAP server, the Byte, ..., Grid data type classes are usually specialized. In each of those specializations read() should be defined to read values from the data source and store them in the object's local buffer. The read() method is called by other methods in this library. When writing read(), follow these rules:

Returns:
The return value of this method for all types except Sequence should always be false. Sequences should return true to indicate more values remain in the Sequence, false to indicate no more values remain. (see Sequence::serialize() and Sequence::read_row()).
Parameters:
dataset A string naming the dataset from which the data is to be read. The meaning of this string will vary among different types of data sources. It may be the name of a data file or an identifier used to read data from a relational database.
See also:
BaseType

Sequence

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

Definition at line 690 of file BaseType.cc.

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

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

Returns true if the value(s) for this variable have been read from the data source, otherwise returns false. This method is used to determine when values need to be read using the read() method. When read_p() returns true, this library assumes that buf2val() (and other methods such as get_vec()) can be used to access the value(s) of a variable.

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

Definition at line 395 of file BaseType.cc.

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

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

Returns the state of the send_p property. If true, this variable should be sent to the client, if false, it should not. If no constraint expression (CE) has been evaluated, this property is true for all variables in a data source (i.e., for all the variables listed in a DDS). If a CE has been evaluated, this property is true only for those variables listed in the projection part of the CE.

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

Definition at line 453 of file BaseType.cc.

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

bool Vector::serialize ( const string &  dataset,
ConstraintEvaluator eval,
DDS dds,
XDR *  sink,
bool  ce_eval = true 
) [virtual]

This uses the BaseType member xdr_coder to encode each element of a cardinal array. See Sun's XDR manual. 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 BaseType.

Definition at line 397 of file Vector.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, DODS_MAX_ARRAY, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, ConstraintEvaluator::eval_selection(), length(), BaseType::read(), BaseType::read_p(), DDS::timeout_off(), DDS::timeout_on(), BaseType::type(), BaseType::width(), BaseType::xdr_coder(), and xdr_str().

Here is the call graph for this function:

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

Set this variable's attribute table.

Parameters:
at Source of the attributes.

Definition at line 488 of file BaseType.cc.

void 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:
state Set the in_selection property to this state.
See also:
BaseType::read()

BaseType::is_in_selection() for more information.

Reimplemented in Grid, Sequence, and Structure.

Definition at line 520 of file BaseType.cc.

Referenced by Structure::set_in_selection(), Sequence::set_in_selection(), and Grid::set_in_selection().

void Vector::set_length ( int  l  )  [virtual]

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

Definition at line 367 of file Vector.cc.

Referenced by Array::clear_constraint(), deserialize(), Array::reset_constraint(), set_value(), PassiveArray::set_value(), and Array::update_length().

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

Definition at line 188 of file BaseType.cc.

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

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

Here is the call graph for this function:

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

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

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

Definition at line 533 of file BaseType.cc.

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

void Vector::set_read_p ( bool  state  )  [virtual]

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

Definition at line 202 of file Vector.cc.

References BaseType::set_read_p().

Referenced by ArrayGeoConstraint::apply_constraint_to_data(), libdap::function_geogrid(), PassiveArray::read(), GeoConstraint::reorder_data_longitude_axis(), libdap::set_array_using_double(), and set_value().

Here is the call graph for this function:

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

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

Definition at line 190 of file Vector.cc.

References BaseType::set_send_p().

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

Here is the call graph for this function:

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

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

See also:
synthesized_p()

Definition at line 378 of file BaseType.cc.

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

Definition at line 203 of file BaseType.cc.

Referenced by Url::Url().

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

Reimplemented in PassiveArray.

Definition at line 928 of file Vector.cc.

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

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 910 of file Vector.cc.

References dods_float64_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 895 of file Vector.cc.

References dods_float32_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 880 of file Vector.cc.

References dods_uint32_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 850 of file Vector.cc.

References dods_int32_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 865 of file Vector.cc.

References dods_uint16_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 835 of file Vector.cc.

References dods_int16_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

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

Reimplemented in PassiveArray.

Definition at line 820 of file Vector.cc.

References dods_byte_c, set_read_p(), BaseType::type(), and var().

Here is the call graph for this function:

void Vector::set_vec ( unsigned int  i,
BaseType val 
)

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:
InternalErr Thrown 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:
i The index of the element to be changed.
val A pointer to the value to be inserted into the array.
See also:
Vector::buf2val

Definition at line 796 of file Vector.cc.

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

Here is the call graph for this function:

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

Returns true if the variable is a synthesized variable. A synthesized variable is one that is added to the dataset by the server (usually with a `projection function'.

Definition at line 367 of file BaseType.cc.

string BaseType::toString (  )  [virtual, inherited]

Write out the object's internal fields in a string. To be used for debugging when regular inspection w/ddd or gdb isn't enough.

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

Reimplemented in Sequence.

Definition at line 134 of file BaseType.cc.

References BaseType::type_name().

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

Here is the call graph for this function:

Type BaseType::type (  )  const [inherited]

Definition at line 196 of file BaseType.cc.

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

string BaseType::type_name (  )  const [inherited]

Definition at line 210 of file BaseType.cc.

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

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

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

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:
val A pointer to the input data.
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.

Implements BaseType.

Definition at line 643 of file Vector.cc.

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

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

Here is the call graph for this function:

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

Definition at line 1001 of file Vector.cc.

References dods_byte_c, and BaseType::type().

Here is the call graph for this function:

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

Definition at line 993 of file Vector.cc.

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

Here is the call graph for this function:

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

Definition at line 985 of file Vector.cc.

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

Here is the call graph for this function:

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

Definition at line 969 of file Vector.cc.

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

Here is the call graph for this function:

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

Definition at line 977 of file Vector.cc.

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

Here is the call graph for this function:

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

Definition at line 953 of file Vector.cc.

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

Here is the call graph for this function:

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

Definition at line 961 of file Vector.cc.

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

Here is the call graph for this function:

void Vector::value ( dods_byte b  )  const [virtual]

Definition at line 945 of file Vector.cc.

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

Here is the call graph for this function:

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

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 threding' is used, I think so. But if the library is running in more than one thread, then this is not thread safe.
Parameters:
i The 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 287 of file Vector.cc.

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

Here is the call graph for this function:

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

This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as 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:
n Find the variable whose name is name.
s Record the path to name.
Returns:
A pointer to the named variable.

Reimplemented from BaseType.

Definition at line 251 of file Vector.cc.

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

Here is the call graph for this function:

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

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:
n The name of the variabe to find.
exact Unused.
s Pointer 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 BaseType.

Definition at line 225 of file Vector.cc.

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

Referenced by Grid::check_semantics(), element_count(), libdap::extract_double_array(), Array::print_decl(), Array::print_xml_core(), PassiveArray::read(), GeoConstraint::reorder_data_longitude_axis(), libdap::set_array_using_double(), set_value(), and PassiveArray::set_value().

Here is the call graph for this function:

void Vector::vec_resize ( int  l  ) 

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 380 of file Vector.cc.

Referenced by deserialize(), and set_vec().

unsigned int Vector::width (  )  [virtual]

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

Implements BaseType.

Definition at line 340 of file Vector.cc.

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

Referenced by buf2val(), deserialize(), and val2buf().

Here is the call graph for this function:

xdrproc_t BaseType::xdr_coder (  )  [inherited]

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

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

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

Definition at line 713 of file BaseType.cc.

Referenced by deserialize(), and serialize().


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