#include <Array.h>
Public Types | ||||
typedef std::vector< dimension > ::const_iterator | Dim_citer | |||
typedef std::vector< dimension > ::iterator | Dim_iter | |||
Public Member Functions | ||||
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 Array &rhs) | ||||
The Array copy constructor. | ||||
Array (const string &n="", BaseType *v=0) | ||||
Array constructor. | ||||
virtual unsigned int | buf2val (void **val) | |||
virtual bool | check_semantics (string &msg, bool all=false) | |||
Check semantic features of the Array. | ||||
void | clear_constraint () | |||
Clears the projection; add each projected dimension explicitly using add_constraint . | ||||
virtual bool | deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) | |||
Receive data from the net. | ||||
Dim_iter | dim_begin () | |||
Dim_iter | dim_end () | |||
string | dimension_name (Dim_iter i) | |||
Returns the name of the specified dimension. | ||||
int | dimension_size (Dim_iter i, bool constrained=false) | |||
Returns the size of the dimension. | ||||
int | dimension_start (Dim_iter i, bool constrained=false) | |||
Return the start index of a dimension. | ||||
int | dimension_stop (Dim_iter i, bool constrained=false) | |||
Return the stop index of the constraint. | ||||
int | dimension_stride (Dim_iter i, bool constrained=false) | |||
Returns the stride value of the constraint. | ||||
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 AttrTable & | get_attr_table () | |||
virtual BaseType * | get_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. | ||||
Array & | operator= (const Array &rhs) | |||
virtual bool | ops (BaseType *b, int op, const string &dataset) | |||
Evaluate relational operators. | ||||
virtual void | print_as_map_xml (ostream &out, string space=" ", bool constrained=false) | |||
virtual void | print_as_map_xml (FILE *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_decl (FILE *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_val (FILE *out, string space="", bool print_decl_p=true) | |||
Prints the value of the variable. | ||||
virtual void | print_xml (ostream &out, string space=" ", bool constrained=false) | |||
virtual void | print_xml (FILE *out, string space=" ", bool constrained=false) | |||
virtual BaseType * | ptr_duplicate () | |||
virtual bool | read (const string &dataset) | |||
Read data into a local buffer. | ||||
virtual bool | read_p () | |||
Has this variable been read? | ||||
void | reset_constraint () | |||
Reset constraint to select entire array. | ||||
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. | ||||
void | update_length (int size) | |||
virtual unsigned int | val2buf (void *val, bool reuse=false) | |||
Reads data into the Vector buffer.
| ||||
virtual BaseType * | var (unsigned int i) | |||
virtual BaseType * | var (const string &name, btp_stack &s) | |||
virtual BaseType * | var (const string &name="", bool exact_match=true, btp_stack *s=0) | |||
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 (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) | |||
void | _duplicate (const Array &a) | |||
void | print_xml_core (ostream &out, string space, bool constrained, string tag) | |||
void | print_xml_core (FILE *out, string space, bool constrained, string tag) | |||
Friends | ||||
class | ArrayTest | |||
Classes | ||||
struct | 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]
Definition at line 96 of file Array.h.
typedef std::vector<dimension>::const_iterator Array::Dim_citer |
typedef std::vector<dimension>::iterator Array::Dim_iter |
Array::Array | ( | const string & | n = "" , |
|
BaseType * | v = 0 | |||
) |
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.
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 Array. |
Definition at line 98 of file Array.cc.
References add_var().
Referenced by ptr_duplicate().
Array::Array | ( | const Array & | rhs | ) |
Definition at line 104 of file Array.cc.
References _duplicate().
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.
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::d_attr, BaseType::d_in_selection, and BaseType::d_parent.
Referenced by BaseType::BaseType(), and BaseType::operator=().
void Vector::_duplicate | ( | const Vector & | v | ) | [protected, inherited] |
Definition at line 57 of file Vector.cc.
References Vector::_buf, Vector::_length, Vector::_var, Vector::_vec, Vector::d_str, BaseType::ptr_duplicate(), BaseType::set_parent(), and Vector::val2buf().
Referenced by Vector::operator=(), and Vector::Vector().
void Array::_duplicate | ( | const Array & | a | ) | [protected] |
void Array::add_constraint | ( | Dim_iter | i, | |
int | start, | |||
int | stride, | |||
int | stop | |||
) |
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.
i | An iterator pointing to the dimension in the list of dimensions. | |
start | The start index of the constraint. | |
stride | The stride value of the constraint. | |
stop | The stop index of the constraint. |
Error | Thrown if the any of values of start, stop or stride cannot be applied to this array. |
Definition at line 281 of file Array.cc.
References Array::dimension::c_size, DBG, malformed_expr, Array::dimension::size, Array::dimension::start, Array::dimension::stop, Array::dimension::stride, and update_length().
Referenced by GridGeoConstraint::apply_constraint_to_data(), and ArrayGeoConstraint::apply_constraint_to_data().
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.
v | The template variable for the array | |
p | The Part parameter defaults to nil and is ignored by this method. |
Reimplemented from Vector.
Definition at line 155 of file Array.cc.
References Vector::add_var(), append_dim(), dim_begin(), dim_end(), dimension_name(), dimension_size(), dods_array_c, BaseType::type(), and Vector::var().
Referenced by Array(), and libdap::function_linear_scale().
void 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.
size | The size of the desired new row. | |
name | The name of the new dimension. This defaults to an empty string. |
Definition at line 184 of file Array.cc.
References Array::dimension::c_size, Array::dimension::name, Array::dimension::size, Array::dimension::start, Array::dimension::stop, Array::dimension::stride, update_length(), and www2id().
Referenced by add_var().
unsigned int 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 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.
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. |
InternalErr | Thrown if val is null. |
Implements BaseType.
Definition at line 767 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 Vector::width().
bool 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()
.
Reimplemented from Vector.
Definition at line 920 of file Array.cc.
References BaseType::check_semantics().
void Array::clear_constraint | ( | ) |
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.
Definition at line 239 of file Array.cc.
References reset_constraint(), and Vector::set_length().
bool 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.
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. |
Error | when a problem reading from the UnMarshaller is found. |
Implements BaseType.
Definition at line 554 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_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, UnMarshaller::get_int(), UnMarshaller::get_str(), UnMarshaller::get_vector(), Vector::length(), BaseType::ptr_duplicate(), Vector::set_length(), BaseType::type(), BaseType::type_name(), Vector::vec_resize(), BaseType::width(), and Vector::width().
Array::Dim_iter Array::dim_begin | ( | ) |
Returns an iterator to the first dimension of the Array.
Definition at line 310 of file Array.cc.
Referenced by add_var(), GridGeoConstraint::apply_constraint_to_data(), Grid::check_semantics(), GSEClause::GSEClause(), print_xml_core(), and Grid::projection_yields_grid().
Array::Dim_iter Array::dim_end | ( | ) |
Returns an iterator past the last dimension of the Array.
Definition at line 317 of file Array.cc.
Referenced by add_var(), print_xml_core(), and Grid::projection_yields_grid().
string Array::dimension_name | ( | Dim_iter | i | ) |
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.
i | The dimension. |
Definition at line 538 of file Array.cc.
Referenced by add_var().
int Array::dimension_size | ( | Dim_iter | i, | |
bool | constrained = false | |||
) |
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
.
i | The dimension. | |
constrained | If 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. |
Definition at line 369 of file Array.cc.
Referenced by add_var(), Grid::check_semantics(), print_val(), and Grid::projection_yields_grid().
int Array::dimension_start | ( | Dim_iter | i, | |
bool | constrained = false | |||
) |
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()
.
i | The dimension. | |
constrained | If 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. |
Definition at line 413 of file Array.cc.
Referenced by GSEClause::GSEClause(), and Grid::projection_yields_grid().
int Array::dimension_stop | ( | Dim_iter | i, | |
bool | constrained = false | |||
) |
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()
.
i | The dimension. | |
constrained | If 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. |
Definition at line 457 of file Array.cc.
Referenced by GSEClause::GSEClause(), and Grid::projection_yields_grid().
int Array::dimension_stride | ( | Dim_iter | i, | |
bool | constrained = false | |||
) |
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()
.
i | The dimension. | |
constrained | If 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. |
Definition at line 502 of file Array.cc.
Referenced by Grid::projection_yields_grid().
unsigned int Array::dimensions | ( | bool | constrained = false |
) |
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.
constrained | A boolean flag to indicate whether the array is constrained or not. By default, constrained is FALSE. |
Definition at line 332 of file Array.cc.
Referenced by Grid::check_semantics(), GridGeoConstraint::GridGeoConstraint(), and print_val().
void Array::dump | ( | ostream & | strm | ) | const [virtual] |
Displays the pointer value of this instance and information about this instance.
strm | C++ i/o stream to dump the information to |
Reimplemented from Vector.
Definition at line 939 of file Array.cc.
References Vector::dump(), DapIndent::Indent(), DapIndent::LMarg(), and DapIndent::UnIndent().
int 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.
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 Vector::var().
Referenced by Grid::element_count().
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 478 of file BaseType.cc.
Referenced by DDS::find_matching_container(), Constructor::find_matching_container(), Grid::print_xml(), Constructor::print_xml(), BaseType::print_xml(), and 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.
Definition at line 548 of file BaseType.cc.
Referenced by DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), Sequence::intern_data_for_leaf(), Sequence::intern_data_parent_part_two(), Sequence::serialize_leaf(), and Sequence::serialize_parent_part_two().
void Vector::intern_data | ( | const string & | dataset, | |
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.
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 BaseType.
Definition at line 402 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, Vector::length(), BaseType::read(), BaseType::read_p(), and BaseType::type().
bool BaseType::is_constructor_type | ( | ) | [virtual, inherited] |
Definition at line 304 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::leaf_match(), DDS::transfer_attributes(), Constructor::transfer_attributes(), and Vector::var().
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.
Definition at line 503 of file BaseType.cc.
bool BaseType::is_simple_type | ( | ) | [virtual, inherited] |
Definition at line 243 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().
bool BaseType::is_vector_type | ( | ) | [virtual, inherited] |
Definition at line 272 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().
int Vector::length | ( | ) | const [virtual, inherited] |
Returns the number of elements in the vector. Note that some child classes of Vector use the length of -1 as a flag value.
Definition at line 356 of file Vector.cc.
Referenced by Vector::deserialize(), libdap::function_linear_scale(), Vector::intern_data(), Vector::serialize(), libdap::set_array_using_double(), update_length(), Vector::value(), and Vector::width().
string BaseType::name | ( | ) | const [inherited] |
Definition at line 171 of file BaseType.cc.
Referenced by Structure::_duplicate(), Vector::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(), Sequence::intern_data(), Sequence::intern_data_for_leaf(), Sequence::intern_data_parent_part_one(), Sequence::intern_data_parent_part_two(), Sequence::intern_data_private(), DDS::leaf_match(), DDS::mark(), Grid::print_decl(), Constructor::print_decl(), Grid::print_xml(), Constructor::print_xml(), 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(), rvalue::value_name(), Vector::var(), Structure::var(), Sequence::var(), and Grid::var().
Definition at line 123 of file Array.cc.
References _duplicate().
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.
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). |
Reimplemented in Byte, Float32, Float64, Int16, Int32, Str, UInt16, and UInt32.
Definition at line 977 of file BaseType.cc.
Referenced by Clause::value().
void Array::print_as_map_xml | ( | ostream & | out, | |
string | space = " " , |
|||
bool | constrained = false | |||
) | [virtual] |
Definition at line 668 of file Array.cc.
References print_xml_core().
void Array::print_as_map_xml | ( | FILE * | out, | |
string | space = " " , |
|||
bool | constrained = false | |||
) | [virtual] |
Definition at line 662 of file Array.cc.
References print_xml_core().
void 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.
out | Write the output to this ostream. | |
space | A string containing spaces to precede the declaration. | |
print_semi | A boolean indicating whether to print a semi-colon after the declaration. (TRUE means ``print a semi-colon.'') | |
constraint_info | A boolean value. See BaseType::print_decl() . | |
constrained | This argument should be TRUE if the Array is constrained, and FALSE otherwise. |
Reimplemented from BaseType.
Definition at line 618 of file Array.cc.
References id2www(), BaseType::print_decl(), BaseType::send_p(), and Vector::var().
void Array::print_decl | ( | FILE * | 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.
out | Write the output to this FILE *. | |
space | A string containing spaces to precede the declaration. | |
print_semi | A boolean indicating whether to print a semi-colon after the declaration. (TRUE means ``print a semi-colon.'') | |
constraint_info | A boolean value. See BaseType::print_decl() . | |
constrained | This argument should be TRUE if the Array is constrained, and FALSE otherwise. |
Reimplemented from BaseType.
Definition at line 569 of file Array.cc.
References id2www(), BaseType::print_decl(), BaseType::send_p(), and Vector::var().
Referenced by print_val().
void 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.
out | The output ostream on which to print the value. | |
space | This value is passed to the print_decl() function, and controls the leading spaces of the output. | |
print_decl_p | A boolean value controlling whether the variable declaration is printed as well as the value. |
Implements BaseType.
Definition at line 883 of file Array.cc.
References dimension_size(), dimensions(), and print_decl().
void Array::print_val | ( | FILE * | out, | |
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual] |
Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.
out | The output FILE on which to print the value. | |
space | This value is passed to the print_decl() function, and controls the leading spaces of the output. | |
print_decl_p | A boolean value controlling whether the variable declaration is printed as well as the value. |
Implements BaseType.
Definition at line 855 of file Array.cc.
References dimension_size(), and print_decl().
void 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.
out | Destination output stream | |
space | Use this to indent child declarations. Default is "". | |
constrained | If true, only print this if it's part part of the current projection. Default is False. |
Reimplemented from BaseType.
Definition at line 656 of file Array.cc.
References print_xml_core().
void Array::print_xml | ( | FILE * | out, | |
string | space = " " , |
|||
bool | constrained = false | |||
) | [virtual] |
Write the XML representation of this variable. This method is used to build the DDX XML response.
out | Destination. | |
space | Use this to indent child declarations. Default is "". | |
constrained | If true, only print this if it's part part of the current projection. Default is False. |
Reimplemented from BaseType.
Definition at line 650 of file Array.cc.
References print_xml_core().
Referenced by Grid::print_xml().
void Array::print_xml_core | ( | ostream & | out, | |
string | space, | |||
bool | constrained, | |||
string | tag | |||
) | [protected] |
Definition at line 742 of file Array.cc.
References dim_begin(), dim_end(), BaseType::get_attr_table(), id2xml(), BaseType::name(), BaseType::print_xml(), AttrTable::print_xml(), BaseType::send_p(), BaseType::set_name(), and Vector::var().
void Array::print_xml_core | ( | FILE * | out, | |
string | space, | |||
bool | constrained, | |||
string | tag | |||
) | [protected] |
Definition at line 696 of file Array.cc.
References dim_begin(), dim_end(), BaseType::get_attr_table(), id2xml(), BaseType::name(), BaseType::print_xml(), AttrTable::print_xml(), BaseType::send_p(), BaseType::set_name(), and Vector::var().
Referenced by print_as_map_xml(), and print_xml().
BaseType * Array::ptr_duplicate | ( | ) | [virtual] |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
this
. Implements Vector.
Definition at line 117 of file Array.cc.
References Array().
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:
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. 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().
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. |
Reimplemented in Structure.
Definition at line 688 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(), Vector::intern_data(), Grid::intern_data(), BaseType::intern_data(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Sequence::read_row(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), Grid::serialize(), Float64::serialize(), Float32::serialize(), and Byte::serialize().
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.
Definition at line 392 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), Vector::intern_data(), Structure::intern_data(), Grid::intern_data(), BaseType::intern_data(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Structure::read(), Sequence::read_row(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Structure::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), Grid::serialize(), Float64::serialize(), Float32::serialize(), and Byte::serialize().
void Array::reset_constraint | ( | ) |
Resets the dimension constraint information so that the entire array is selected.
Definition at line 212 of file Array.cc.
References Vector::set_length(), and update_length().
Referenced by clear_constraint().
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.
Definition at line 450 of file BaseType.cc.
Referenced by Grid::components(), Grid::intern_data(), Grid::print_decl(), Constructor::print_decl(), BaseType::print_decl(), print_decl(), Grid::print_val(), Grid::print_xml(), Constructor::print_xml(), BaseType::print_xml(), print_xml_core(), Grid::projection_yields_grid(), and Grid::serialize().
bool Vector::serialize | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds, | |||
Marshaller & | m, | |||
bool | ce_eval = true | |||
) | [virtual, inherited] |
This uses the Marshaller 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 BaseType.
Definition at line 466 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, ConstraintEvaluator::eval_selection(), Vector::length(), Marshaller::put_int(), Marshaller::put_str(), Marshaller::put_vector(), BaseType::read(), BaseType::read_p(), DDS::timeout_off(), DDS::timeout_on(), BaseType::type(), and BaseType::width().
void BaseType::set_attr_table | ( | const AttrTable & | at | ) | [virtual, inherited] |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 486 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.
state | Set the in_selection property to this state. |
BaseType::is_in_selection() for more information.
Reimplemented in Grid, Sequence, and Structure.
Definition at line 518 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, inherited] |
Sets the length of the vector. This function does not allocate any new space.
Definition at line 367 of file Vector.cc.
Referenced by clear_constraint(), Vector::deserialize(), reset_constraint(), Vector::set_value(), and update_length().
void BaseType::set_name | ( | const string & | n | ) | [virtual, inherited] |
Definition at line 178 of file BaseType.cc.
References BaseType::name(), and www2id().
Referenced by Vector::add_var(), and print_xml_core().
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.
parent | Pointer to the Constructor of Vector parent variable. |
InternalErr | thrown if called with anything other than a Constructor or Vector. |
Definition at line 531 of file BaseType.cc.
Referenced by Vector::_duplicate(), Vector::add_var(), Structure::add_var(), Sequence::add_var(), Grid::add_var(), and Vector::Vector().
void 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 BaseType.
Definition at line 202 of file Vector.cc.
References BaseType::set_read_p().
Referenced by ArrayGeoConstraint::apply_constraint_to_data(), libdap::function_geogrid(), libdap::set_array_using_double(), and Vector::set_value().
void 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 BaseType.
Definition at line 190 of file Vector.cc.
References BaseType::set_send_p().
Referenced by libdap::function_grid(), and libdap::function_linear_scale().
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!
Definition at line 375 of file BaseType.cc.
void BaseType::set_type | ( | const Type & | t | ) | [inherited] |
bool Vector::set_value | ( | vector< string > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1111 of file Vector.cc.
References dods_str_c, dods_url_c, Vector::set_length(), Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | string * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1093 of file Vector.cc.
References dods_str_c, dods_url_c, Vector::set_length(), Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_float64 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1075 of file Vector.cc.
References dods_float64_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_float64 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1057 of file Vector.cc.
References dods_float64_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_float32 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1039 of file Vector.cc.
References dods_float32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_float32 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1024 of file Vector.cc.
References dods_float32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_uint32 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 1006 of file Vector.cc.
References dods_uint32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_uint32 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 991 of file Vector.cc.
References dods_uint32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_int32 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 940 of file Vector.cc.
References dods_int32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_int32 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 925 of file Vector.cc.
References dods_int32_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_uint16 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 973 of file Vector.cc.
References dods_uint16_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_uint16 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 958 of file Vector.cc.
References dods_uint16_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_int16 > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 907 of file Vector.cc.
References dods_int16_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_int16 * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 892 of file Vector.cc.
References dods_int16_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | vector< dods_byte > & | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 874 of file Vector.cc.
References dods_byte_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
bool Vector::set_value | ( | dods_byte * | val, | |
int | sz | |||
) | [virtual, inherited] |
Definition at line 859 of file Vector.cc.
References dods_byte_c, Vector::set_read_p(), BaseType::type(), and Vector::var().
void 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.
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. |
i | The index of the element to be changed. | |
val | A pointer to the value to be inserted into the array. |
Definition at line 833 of file Vector.cc.
References BaseType::ptr_duplicate(), BaseType::type(), and Vector::vec_resize().
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 364 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.
Reimplemented in Sequence.
Definition at line 124 of file BaseType.cc.
References BaseType::type_name().
Referenced by GSEClause::GSEClause(), and Sequence::toString().
Type BaseType::type | ( | ) | const [inherited] |
Definition at line 186 of file BaseType.cc.
Referenced by add_var(), Vector::buf2val(), Grid::check_semantics(), Vector::deserialize(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), XDRFileUnMarshaller::get_vector(), Vector::intern_data(), Sequence::intern_data_for_leaf(), Sequence::intern_data_parent_part_two(), 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(), XDRStreamMarshaller::put_vector(), XDRFileMarshaller::put_vector(), Vector::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_two(), libdap::set_array_using_double(), Vector::set_value(), Vector::set_vec(), Vector::val2buf(), Vector::value(), and Vector::var().
string BaseType::type_name | ( | ) | const [inherited] |
Definition at line 200 of file BaseType.cc.
References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, and dods_url_c.
Referenced by Vector::add_var(), Structure::check_semantics(), Sequence::check_semantics(), Grid::check_semantics(), Vector::deserialize(), BaseType::dump(), Grid::print_decl(), Constructor::print_decl(), BaseType::print_decl(), Constructor::print_xml(), BaseType::print_xml(), and BaseType::toString().
void Array::update_length | ( | int | size | ) |
size
. This does not change the actual size of the array.
Definition at line 70 of file Array.cc.
References Vector::length(), and Vector::set_length().
Referenced by add_constraint(), append_dim(), and reset_constraint().
unsigned int 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.
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 680 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 Vector::width().
Referenced by Vector::_duplicate(), GridGeoConstraint::apply_constraint_to_data(), ArrayGeoConstraint::apply_constraint_to_data(), and libdap::function_linear_scale().
void * 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 1200 of file Vector.cc.
References Vector::width().
void Vector::value | ( | vector< string > & | b | ) | const [virtual, inherited] |
Definition at line 1192 of file Vector.cc.
References dods_byte_c, and BaseType::type().
void Vector::value | ( | dods_float64 * | b | ) | const [virtual, inherited] |
Definition at line 1184 of file Vector.cc.
References dods_float64_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_float32 * | b | ) | const [virtual, inherited] |
Definition at line 1176 of file Vector.cc.
References dods_float32_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_uint32 * | b | ) | const [virtual, inherited] |
Definition at line 1160 of file Vector.cc.
References dods_uint32_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_int32 * | b | ) | const [virtual, inherited] |
Definition at line 1168 of file Vector.cc.
References dods_int32_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_uint16 * | b | ) | const [virtual, inherited] |
Definition at line 1144 of file Vector.cc.
References dods_uint16_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_int16 * | b | ) | const [virtual, inherited] |
Definition at line 1152 of file Vector.cc.
References dods_int16_c, Vector::length(), and BaseType::type().
void Vector::value | ( | dods_byte * | b | ) | const [virtual, inherited] |
b | A pointer to the memory to hold the data; must be at least length() * sizeof(dods_byte) in size. |
Definition at line 1136 of file Vector.cc.
References dods_byte_c, Vector::length(), and BaseType::type().
BaseType * 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.
i | The index of the desired Vector element. Zero indicates the first element of the Vector. |
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().
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.
n | Find the variable whose name is name. | |
s | Record the path to name. |
Reimplemented from BaseType.
Definition at line 251 of file Vector.cc.
References BaseType::is_constructor_type(), BaseType::name(), BaseType::var(), and www2id().
BaseType * 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.
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. |
Reimplemented from BaseType.
Definition at line 225 of file Vector.cc.
References BaseType::is_constructor_type(), BaseType::name(), BaseType::var(), and www2id().
Referenced by add_var(), Grid::check_semantics(), Vector::element_count(), libdap::extract_double_array(), XDRFileUnMarshaller::get_vector(), print_decl(), print_xml_core(), XDRStreamMarshaller::put_vector(), XDRFileMarshaller::put_vector(), libdap::set_array_using_double(), and Vector::set_value().
void 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 380 of file Vector.cc.
Referenced by Vector::deserialize(), and Vector::set_vec().
unsigned int 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 BaseType.
Definition at line 340 of file Vector.cc.
References Vector::length(), and BaseType::width().
Referenced by Vector::buf2val(), Vector::deserialize(), Vector::val2buf(), and Vector::value().