libdap++
Updated for version 3.13.1
|
Holds a structure (aggregate) type. More...
#include <Structure.h>
Public Types | |
typedef stack< BaseType * > | btp_stack |
typedef std::vector< BaseType * > ::const_iterator | Vars_citer |
typedef std::vector< BaseType * > ::iterator | Vars_iter |
typedef std::vector< BaseType * > ::reverse_iterator | Vars_riter |
Public Member Functions | |
virtual void | add_var (BaseType *bt, Part part=nil) |
virtual void | add_var_nocopy (BaseType *bt, Part part=nil) |
virtual unsigned int | buf2val (void **) |
Reads the class data. More... | |
virtual bool | check_semantics (string &msg, bool all=false) |
Compare an object's current state with the semantics of its type. More... | |
string | dataset () const |
Returns the name of the dataset used to create this instance. More... | |
virtual void | del_var (const string &name) |
virtual void | del_var (Vars_iter i) |
virtual bool | deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) |
Receive data from the net. More... | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual int | element_count (bool leaves=false) |
Count the members of constructor types. More... | |
virtual AttrTable & | get_attr_table () |
virtual BaseType * | get_parent () |
BaseType * | get_var_index (int i) |
Vars_iter | get_vars_iter (int i) |
virtual void | intern_data (ConstraintEvaluator &eval, DDS &dds) |
virtual bool | is_constructor_type () |
Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. More... | |
bool | is_dap4 () |
virtual bool | is_in_selection () |
Is this variable part of the current selection? More... | |
virtual bool | is_linear () |
Check to see whether this variable can be printed simply. More... | |
virtual bool | is_simple_type () |
Returns true if the instance is a numeric, string or URL type variable. More... | |
virtual bool | is_vector_type () |
Returns true if the instance is a vector (i.e., array) type variable. More... | |
string | name () const |
Returns the name of the class instance. More... | |
Structure & | operator= (const Structure &rhs) |
virtual bool | ops (BaseType *b, int op) |
Evaluate relational operators. More... | |
virtual void | print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) |
Print an ASCII representation of the variable structure. More... | |
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. More... | |
virtual void | print_val (FILE *out, string space="", bool print_decl_p=true) |
Prints the value of the variable. More... | |
virtual void | print_val (ostream &out, string space="", bool print_decl_p=true) |
Prints the value of the variable. More... | |
virtual void | print_xml (ostream &out, string space=" ", bool constrained=false) |
virtual void | print_xml (FILE *out, string space=" ", bool constrained=false) |
virtual void | print_xml_writer (XMLWriter &xml, bool constrained=false) |
virtual BaseType * | ptr_duplicate () |
virtual bool | read () |
simple implementation of read that iterates through vars and calls read on them More... | |
virtual bool | read_p () |
Has this variable been read? More... | |
virtual bool | send_p () |
Should this variable be sent? More... | |
virtual bool | serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) |
Move data to the net. More... | |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
Set the in_selection property. More... | |
void | set_is_dap4 (const bool v) |
virtual void | set_leaf_sequence (int level=1) |
Traverse Structure, set Sequence leaf nodes. More... | |
virtual void | set_name (const string &n) |
Sets the name of the class instance. More... | |
virtual void | set_parent (BaseType *parent) |
virtual void | set_read_p (bool state) |
Sets the value of the read_p property. More... | |
virtual void | set_send_p (bool state) |
virtual void | set_synthesized_p (bool state) |
void | set_type (const Type &t) |
Sets the type of the class instance. More... | |
Structure (const string &n) | |
Structure (const string &n, const string &d) | |
Structure (const Structure &rhs) | |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable *at) |
Type | type () const |
Returns the type of the class instance. More... | |
string | type_name () const |
Returns the type of the class instance as a string. More... | |
virtual unsigned int | val2buf (void *, bool) |
Loads class data. More... | |
virtual BaseType * | var (const string &name, bool exact_match=true, btp_stack *s=0) |
btp_stack no longer needed; use back pointers (BaseType::get_parent()) More... | |
virtual BaseType * | var (const string &n, btp_stack &s) |
Vars_iter | var_begin () |
Vars_iter | var_end () |
Vars_riter | var_rbegin () |
Vars_riter | var_rend () |
virtual unsigned int | width (bool constrained=false) |
virtual | ~Structure () |
Protected Member Functions | |
void | m_duplicate (const Constructor &s) |
void | m_duplicate (const BaseType &bt) |
Perform a deep copy. More... | |
BaseType * | m_exact_match (const string &name, btp_stack *s=0) |
BaseType * | m_leaf_match (const string &name, btp_stack *s=0) |
Protected Attributes | |
std::vector< BaseType * > | d_vars |
This data type is used to hold a collection of related data types, in a manner roughly corresponding to a C structure. The member types can be simple or compound types, and can include other Structures.
The DAP2 structure is defined as a singly-linked list. This means that Structure elements can be accessed either by name, with the var()
function, or by their position in the list, either with the overloaded version of var()
, or the combination of the first_var()
and next_var()
functions.
The val2buf()
and buf2val()
functions only return the size of the structure. To read parts of a DAP2 Structure into an application program, use the buf2val()
function of the element of the Structure in question.
Note that the predicate-setting functions set_send_p()
and set_read_p()
set their flags for the Structure as well as for each of the Structure's member elements.
Similar to C, you can refer to members of Structure elements with a .'' notation. For example, if the Structure has a member Structure called
Tom'' and Tom has a member Float32 called shoe_size'', then you can refer to Tom's shoe size as
Tom.shoe_size''.
Definition at line 85 of file Structure.h.
|
inherited |
Definition at line 233 of file BaseType.h.
|
inherited |
Definition at line 55 of file Constructor.h.
|
inherited |
Definition at line 56 of file Constructor.h.
|
inherited |
Definition at line 57 of file Constructor.h.
libdap::Structure::Structure | ( | const string & | n | ) |
The Structure constructor requires only the name of the variable to be created. The name may be omitted, which will create a nameless variable. This may be adequate for some applications.
n | A string containing the name of the variable to be created. |
Definition at line 106 of file Structure.cc.
Referenced by ptr_duplicate().
libdap::Structure::Structure | ( | const string & | n, |
const string & | d | ||
) |
The Structure server-side constructor requires the name of the variable to be created and the dataset name from which this variable is being created. Used on server-side handlers.
n | A string containing the name of the variable to be created. |
d | A string containing the name of the dataset from which this variable is being created. |
Definition at line 118 of file Structure.cc.
libdap::Structure::Structure | ( | const Structure & | rhs | ) |
The Structure copy constructor.
Definition at line 123 of file Structure.cc.
References libdap::Constructor::m_duplicate().
|
virtual |
Definition at line 128 of file Structure.cc.
References libdap::Constructor::d_vars.
Adds an element to a Constructor.
bt | A pointer to the variable to add to this Constructor. |
part | Not used by this class, defaults to nil |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 321 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().
Referenced by libdap::DDS::add_var().
Adds an element to a Constructor.
bt | A pointer to thee variable to add to this Constructor. |
part | Not used by this class, defaults to nil |
Reimplemented in libdap::Grid.
Definition at line 346 of file Constructor.cc.
References libdap::Constructor::d_vars, and libdap::BaseType::set_parent().
Referenced by libdap::DDS::add_var_nocopy().
|
inlinevirtualinherited |
Reads the class data into the memory referenced by <i>val</i>. The caller should either allocate enough storage to <i>val</i> to hold the class data or set \c *val to null. If <i>*val</i> is NULL, memory will be allocated by this function with <tt>new()</tt>. If the memory is allocated this way, the caller is responsible for deallocating that memory. Array and values for simple types are stored as C would store an array.
@param 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 references by this pointer. @return The size (in bytes) of the information copied to <i>val</i>.
Implements libdap::BaseType.
Definition at line 102 of file Constructor.h.
|
virtualinherited |
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.
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. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 583 of file Constructor.cc.
References libdap::BaseType::check_semantics(), libdap::Constructor::d_vars, libdap::BaseType::name(), libdap::BaseType::type_name(), and libdap::unique_names().
|
inherited |
A dataset from which the data is to be read. The meaning of this string will vary among different types of data sources. It may be the name of a data file or an identifier used to read data from a relational database.
Definition at line 275 of file BaseType.cc.
Referenced by libdap::Sequence::read_row(), libdap::Int8::serialize(), libdap::Int64::serialize(), libdap::UInt64::serialize(), libdap::Int16::serialize(), libdap::UInt16::serialize(), libdap::UInt32::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), libdap::Byte::serialize(), libdap::Int32::serialize(), libdap::Str::serialize(), libdap::Constructor::serialize(), libdap::Vector::serialize(), and libdap::Grid::serialize().
|
virtualinherited |
Remove an element from a Constructor.
n | name of the variable to remove |
Definition at line 362 of file Constructor.cc.
References libdap::Constructor::d_vars.
Referenced by libdap::DDS::del_var().
|
virtualinherited |
Definition at line 375 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
virtualinherited |
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 libdap::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 451 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
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 libdap::Constructor.
Definition at line 598 of file Structure.cc.
References libdap::Constructor::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().
|
virtualinherited |
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 libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 110 of file Constructor.cc.
References libdap::Constructor::d_vars.
Referenced by libdap::Sequence::print_one_row().
|
virtualinherited |
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 666 of file BaseType.cc.
Referenced by libdap::D4ParserSax2::ddx_start_element(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::BaseType::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::Grid::transfer_attributes(), and libdap::BaseType::transfer_attributes().
|
virtualinherited |
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 788 of file BaseType.cc.
Referenced by libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_two().
|
inherited |
Return the BaseType pointer for the ith variable.
i | This index |
Definition at line 311 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
inherited |
Return the iterator for the ith variable.
i | the index |
Definition at line 302 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
virtualinherited |
Similar to using serialize() and deserialize() together in one object. Data are read as for serialize and those values are stored in the objects as deserialize() does but does not write and then read data to/from a stream.
This method is defined by the various data type classes. It calls the read() abstract method.
eval | Use this as the constraint expression evaluator. |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 402 of file Constructor.cc.
References libdap::Constructor::d_vars, DBG, libdap::BaseType::name(), libdap::Constructor::read(), and libdap::BaseType::read_p().
|
virtualinherited |
Definition at line 449 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_enum_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_group_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_int64_c, libdap::dods_int8_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_uint64_c, libdap::dods_uint8_c, libdap::dods_url4_c, libdap::dods_url_c, libdap::is_constructor_type(), and libdap::BaseType::type().
Referenced by libdap::D4ParserSax2::ddx_end_element(), libdap::DDXParser::ddx_sax2_end_element(), libdap::DDS::leaf_match(), and libdap::Vector::var().
|
inlineinherited |
Definition at line 252 of file BaseType.h.
|
virtualinherited |
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 740 of file BaseType.cc.
|
virtual |
True if the instance can be flattened and printed as a single table of values. For Arrays and Grids this is always false. For Structures and Sequences the conditions are more complex. The implementation provided by this class always returns false. Other classes should override this implementation.
Reimplemented from libdap::Constructor.
Definition at line 172 of file Structure.cc.
References libdap::Constructor::d_vars, and libdap::dods_structure_c.
|
virtualinherited |
Definition at line 358 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_enum_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_group_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_int64_c, libdap::dods_int8_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_uint64_c, libdap::dods_uint8_c, libdap::dods_url4_c, libdap::dods_url_c, libdap::is_simple_type(), and libdap::BaseType::type().
Referenced by libdap::Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().
|
virtualinherited |
Definition at line 402 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_enum_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_group_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_int64_c, libdap::dods_int8_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_uint64_c, libdap::dods_uint8_c, libdap::dods_url4_c, libdap::dods_url_c, libdap::is_vector_type(), and libdap::BaseType::type().
Referenced by libdap::D4ParserSax2::ddx_end_element(), libdap::DDXParser::ddx_sax2_end_element(), and libdap::DDS::leaf_match().
|
protectedinherited |
Definition at line 59 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().
Referenced by libdap::D4Group::D4Group(), libdap::D4Group::operator=(), libdap::Constructor::operator=(), operator=(), and Structure().
|
protectedinherited |
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 80 of file BaseType.cc.
References DBG2.
Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().
|
protectedinherited |
Definition at line 235 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::BaseType::name(), libdap::Constructor::var(), and libdap::BaseType::var().
Referenced by libdap::Constructor::var().
|
protectedinherited |
Definition at line 208 of file Constructor.cc.
References libdap::Constructor::d_vars, DBG, libdap::BaseType::name(), and libdap::BaseType::var().
Referenced by libdap::Constructor::var().
|
inherited |
Definition at line 254 of file BaseType.cc.
Referenced by libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Constructor::check_semantics(), libdap::Grid::check_semantics(), libdap::Sequence::deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::Constructor::intern_data(), libdap::Vector::intern_data(), libdap::Sequence::intern_data(), libdap::BaseType::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::intern_data_private(), libdap::DDS::leaf_match(), libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::BaseType::read(), libdap::Sequence::read_row(), libdap::DODSFilter::send_data_ddx(), libdap::Str::serialize(), libdap::Sequence::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), libdap::Sequence::set_leaf_sequence(), libdap::BaseType::set_name(), libdap::BaseType::set_read_p(), libdap::BaseType::set_send_p(), libdap::Grid::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::Vector::value(), libdap::rvalue::value_name(), libdap::Constructor::var(), libdap::Grid::var(), libdap::Vector::var(), and libdap::Sequence::var_value().
Definition at line 143 of file Structure.cc.
References libdap::Constructor::m_duplicate().
|
virtualinherited |
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 . |
Reimplemented in libdap::Str, libdap::Int32, libdap::Float32, libdap::Float64, libdap::UInt32, libdap::Byte, libdap::Int16, libdap::UInt16, libdap::UInt64, libdap::Int64, and libdap::Int8.
Definition at line 1198 of file BaseType.cc.
Referenced by libdap::Clause::value().
|
virtualinherited |
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;
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. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 470 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().
Referenced by libdap::Constructor::print_decl(), libdap::Constructor::print_val(), and libdap::Sequence::print_val_by_rows().
|
virtualinherited |
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;
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. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 461 of file Constructor.cc.
References libdap::Constructor::print_decl().
|
virtualinherited |
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 stream 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 libdap::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 494 of file Constructor.cc.
|
virtualinherited |
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 libdap::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 502 of file Constructor.cc.
References libdap::Constructor::d_vars, and libdap::Constructor::print_decl().
|
virtualinherited |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 536 of file Constructor.cc.
References libdap::XMLWriter::get_doc(), and libdap::Constructor::print_xml_writer().
|
virtualinherited |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 525 of file Constructor.cc.
References libdap::XMLWriter::get_doc(), libdap::XMLWriter::get_doc_size(), and libdap::Constructor::print_xml_writer().
|
virtualinherited |
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 libdap::BaseType.
Reimplemented in libdap::Grid, and libdap::D4Group.
Definition at line 559 of file Constructor.cc.
References libdap::BaseType::get_attr_table(), libdap::AttrTable::get_size(), libdap::XMLWriter::get_writer(), libdap::BaseType::name(), libdap::AttrTable::print_xml_writer(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Referenced by libdap::Constructor::print_xml().
|
virtual |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
this
. Implements libdap::BaseType.
Definition at line 137 of file Structure.cc.
References Structure().
|
virtualinherited |
Reimplemented from libdap::BaseType.
Definition at line 389 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::BaseType::read_p(), and libdap::Constructor::set_read_p().
Referenced by libdap::Constructor::intern_data(), libdap::Grid::intern_data(), libdap::Sequence::read_row(), libdap::Constructor::serialize(), and libdap::Grid::serialize().
|
virtualinherited |
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 579 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::Constructor::intern_data(), libdap::Vector::intern_data(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::Int8::ops(), libdap::Int64::ops(), libdap::UInt64::ops(), libdap::UInt16::ops(), libdap::Int16::ops(), libdap::Byte::ops(), libdap::UInt32::ops(), libdap::Float32::ops(), libdap::Float64::ops(), libdap::Int32::ops(), libdap::Str::ops(), libdap::Constructor::read(), libdap::Sequence::read_row(), libdap::Int8::serialize(), libdap::Int64::serialize(), libdap::UInt64::serialize(), libdap::Int16::serialize(), libdap::UInt16::serialize(), libdap::UInt32::serialize(), libdap::Float32::serialize(), libdap::Float64::serialize(), libdap::Byte::serialize(), libdap::Int32::serialize(), libdap::Str::serialize(), libdap::Constructor::serialize(), libdap::Vector::serialize(), libdap::Grid::serialize(), and libdap::Vector::set_value_slice_from_row_major_vector().
|
virtualinherited |
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 638 of file BaseType.cc.
Referenced by libdap::Grid::components(), libdap::Grid::intern_data(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::Array::print_decl(), libdap::BaseType::print_decl(), libdap::Grid::print_val(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::BaseType::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::Grid::projection_yields_grid(), libdap::Grid::serialize(), and libdap::Grid::width().
|
virtualinherited |
Sends the data from the indicated (local) dataset through the connection identified by the sink parameter. If the data is not already incorporated into the DDS object, read the data from the dataset.
This function is only used on the server side of the client/server connection, and is generally only called from the ResponseBuilder functions. It has no BaseType implementation; each datatype child class supplies its own implementation.
eval | Use this as the constraint expression evaluator. |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. |
m | A marshaller used to serialize data types |
ce_eval | A boolean value indicating whether to evaluate the DODS constraint expression that may accompany this dataset. The constraint expression is stored in dds. |
InternalErr. | |
Error. |
Implements libdap::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 416 of file Constructor.cc.
References libdap::Constructor::d_vars, libdap::BaseType::dataset(), libdap::dods_grid_c, libdap::dods_structure_c, libdap::ConstraintEvaluator::eval_selection(), libdap::Constructor::read(), libdap::BaseType::read_p(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().
|
virtualinherited |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 674 of file BaseType.cc.
|
virtualinherited |
Set the in_selection property for this variable and all of its children.
state | Set the property value to state. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 625 of file Constructor.cc.
References libdap::Constructor::d_vars, and libdap::BaseType::set_in_selection().
|
inlineinherited |
Definition at line 253 of file BaseType.h.
|
virtual |
Definition at line 224 of file Structure.cc.
References libdap::dods_sequence_c, libdap::dods_structure_c, libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Referenced by libdap::Sequence::set_leaf_sequence().
|
virtualinherited |
Definition at line 261 of file BaseType.cc.
References libdap::BaseType::name(), and libdap::www2id().
Referenced by libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Array::print_xml_writer_core(), and libdap::Vector::set_name().
|
virtualinherited |
Set the parent
property for this variable.
parent | Pointer to the Constructor of Vector parent variable or null if the variable has no parent (if it is at the top-level of a DAP2/3 DDS). |
InternalErr | thrown if called with anything other than a Constructor, Vector or Null. |
Definition at line 770 of file BaseType.cc.
Referenced by libdap::Vector::_duplicate(), libdap::Grid::add_map(), libdap::Constructor::add_var(), libdap::Grid::add_var(), libdap::Vector::add_var(), libdap::Constructor::add_var_nocopy(), libdap::Grid::add_var_nocopy(), libdap::Vector::add_var_nocopy(), libdap::DDXParser::ddx_end_document(), libdap::Constructor::m_duplicate(), libdap::Grid::m_duplicate(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().
|
virtualinherited |
Sets the value of the read_p
property. This indicates that the value(s) of this variable has/have been read. An implementation of the read() method would typically use this to set the read_p
property to true.
state | Set the read_p property to this state. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 134 of file Constructor.cc.
References libdap::Constructor::d_vars, and libdap::BaseType::set_read_p().
Referenced by libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Constructor::read(), libdap::Sequence::read_row(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_one().
|
virtualinherited |
Sets the value of the send_p
flag. This function is meant to be called from within the constraint evaluator of other code which determines that this variable should be returned to the client. Data are ready to be sent when both the d_is_send
and d_is_read
flags are set to TRUE.
state | The logical state to set the send_p flag. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 124 of file Constructor.cc.
References libdap::Constructor::d_vars, and libdap::BaseType::set_send_p().
|
virtualinherited |
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 562 of file BaseType.cc.
|
inherited |
Definition at line 289 of file BaseType.cc.
Referenced by libdap::D4BaseTypeFactory::NewUInt8(), libdap::D4BaseTypeFactory::NewURL(), and libdap::Url::Url().
|
virtualinherited |
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 551 of file BaseType.cc.
|
virtualinherited |
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 libdap::Sequence.
Definition at line 205 of file BaseType.cc.
References libdap::BaseType::type_name().
Referenced by libdap::Sequence::toString().
|
virtualinherited |
Transfer attributes from a DAS object into this variable. Because of the rough history of the DAS object and the way that various server code built the DAS, this is necessarily a heuristic process. The intent is that this method will be overridden by handlers that need to look for certain patterns in the DAS (e.g., hdf4's odd variable_dim_n; where n = 0, 1, 2, ...) attribute containers.
There should be a one-to-one mapping between variables and attribute containers. However, in some cases one variable has attributes spread across several top level containers and in some cases one container is used by several variables
at_container | Transfer attributes from this container. |
Reimplemented in libdap::Grid.
Definition at line 705 of file BaseType.cc.
References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), DBG, libdap::BaseType::get_attr_table(), libdap::AttrTable::get_attr_table(), libdap::AttrTable::get_attr_type(), libdap::AttrTable::get_attr_vector(), libdap::AttrTable::get_name(), libdap::AttrTable::get_type(), libdap::BaseType::name(), and libdap::AttrTable::set_is_global_attribute().
Referenced by libdap::Grid::transfer_attributes().
|
inherited |
Definition at line 282 of file BaseType.cc.
Referenced by libdap::Array::add_var(), libdap::Array::add_var_nocopy(), libdap::Vector::buf2val(), libdap::Grid::check_semantics(), libdap::D4ParserSax2::ddx_end_element(), libdap::Vector::deserialize(), libdap::Vector::dump(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::XDRFileUnMarshaller::get_vector(), libdap::XDRStreamUnMarshaller::get_vector(), libdap::Vector::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::BaseType::is_constructor_type(), libdap::BaseType::is_simple_type(), libdap::BaseType::is_vector_type(), libdap::Vector::m_is_cardinal_type(), libdap::Int8::ops(), libdap::Int64::ops(), libdap::UInt64::ops(), libdap::UInt16::ops(), libdap::Int16::ops(), libdap::Byte::ops(), libdap::UInt32::ops(), libdap::Float32::ops(), libdap::Float64::ops(), libdap::Int32::ops(), libdap::Str::ops(), libdap::Sequence::print_one_row(), libdap::XDRFileMarshaller::put_vector(), libdap::XDRStreamMarshaller::put_vector(), libdap::Vector::reserve_value_capacity(), libdap::Vector::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_two(), libdap::set_array_using_double(), libdap::Vector::set_value(), libdap::Vector::set_value_slice_from_row_major_vector(), libdap::Vector::set_vec(), libdap::Vector::val2buf(), libdap::Vector::value(), and libdap::Vector::var().
|
inherited |
Definition at line 296 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_enum_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_group_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_int64_c, libdap::dods_int8_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_uint64_c, libdap::dods_uint8_c, libdap::dods_url4_c, libdap::dods_url_c, and libdap::type_name().
Referenced by libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Constructor::check_semantics(), libdap::Vector::deserialize(), libdap::BaseType::dump(), libdap::DDS::mark(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::BaseType::print_decl(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), libdap::BaseType::print_xml_writer(), and libdap::BaseType::toString().
|
inlinevirtualinherited |
Store the value pointed to by <i>val</i> in the object's internal buffer. This function does not perform any checks, so users must be sure that the thing pointed to can actually be stored in the object's buffer. Only simple objects (Int, Float, Byte, and so on) and arrays of these simple objects may be stored using this function. To put data into more complex constructor types, use the functions provided by that class.
@param val A pointer to the data to be inserted into the class data buffer. @param 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 <i>not</i> reallocated. If FALSE, new storage is allocated. If the internal buffer has not been allocated at all, this argument has no effect. This is currently used only in the Vector class. @return The size (in bytes) of the information copied from <i>val</i>. @see Grid @see Vector::val2buf
Implements libdap::BaseType.
Definition at line 99 of file Constructor.h.
|
virtualinherited |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 183 of file Constructor.cc.
References libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), and libdap::www2id().
Referenced by libdap::Constructor::m_exact_match(), and libdap::DDS::var().
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 195 of file Constructor.cc.
References libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), libdap::BaseType::name(), and libdap::www2id().
|
inherited |
Returns an iterator referencing the first structure element.
Definition at line 270 of file Constructor.cc.
References libdap::Constructor::d_vars.
Referenced by libdap::DDXParser::ddx_end_document(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::m_duplicate(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), and set_leaf_sequence().
|
inherited |
Returns an iterator referencing the end of the list of structure elements. Does not reference the last structure element.
Definition at line 278 of file Constructor.cc.
References libdap::Constructor::d_vars.
Referenced by libdap::DDXParser::ddx_end_document(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::m_duplicate(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), and set_leaf_sequence().
|
inherited |
Return a reverse iterator that references the last element.
Definition at line 285 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
inherited |
Return a reverse iterator that references a point 'before' the first element.
Definition at line 293 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
virtualinherited |
This version of width simply returns the same thing as width() for simple types and Arrays. For Structure it returns the total size if constrained is false, or the size of the elements in the current projection if true.
constrained | If true, return the size after applying a constraint. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 165 of file Constructor.cc.
References libdap::Constructor::d_vars.
|
protectedinherited |
Definition at line 43 of file Constructor.h.
Referenced by libdap::Grid::add_map(), libdap::Constructor::add_var(), libdap::Grid::add_var(), libdap::Constructor::add_var_nocopy(), libdap::Grid::add_var_nocopy(), libdap::Constructor::check_semantics(), libdap::Constructor::del_var(), libdap::Constructor::deserialize(), libdap::Sequence::deserialize(), libdap::Constructor::dump(), libdap::Constructor::element_count(), libdap::Constructor::get_var_index(), libdap::Constructor::get_vars_iter(), libdap::Constructor::intern_data(), is_linear(), libdap::Sequence::is_linear(), libdap::Constructor::m_duplicate(), libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), libdap::Grid::prepend_map(), libdap::Constructor::print_decl(), libdap::Constructor::print_val(), libdap::Constructor::read(), libdap::Constructor::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), libdap::Constructor::set_in_selection(), libdap::Sequence::set_leaf_sequence(), libdap::Constructor::set_read_p(), libdap::Constructor::set_send_p(), libdap::Sequence::toString(), libdap::Constructor::var_begin(), libdap::Constructor::var_end(), libdap::Constructor::var_rbegin(), libdap::Constructor::var_rend(), libdap::Constructor::width(), libdap::Sequence::~Sequence(), and ~Structure().