libdap++ Updated for version 3.8.2
|
Holds a sequence. More...
#include <Sequence.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 *, Part part=nil) |
Adds a variable to the Sequence. | |
virtual unsigned int | buf2val (void **val) |
virtual bool | check_semantics (string &msg, bool all=false) |
Compare an object's current state with the semantics of its type. | |
string | dataset () const |
Returns the name of the dataset used to create this instance. | |
virtual bool | deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) |
Deserialize (read from the network) the entire Sequence. | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual int | element_count (bool leaves=false) |
Count the members of constructor types. | |
virtual AttrTable & | get_attr_table () |
virtual int | get_ending_row_number () |
Get the ending row number. | |
virtual BaseType * | get_parent () |
virtual int | get_row_stride () |
Get the row stride. | |
int | get_starting_row_number () |
Get the starting row number. | |
bool | get_unsent_data () |
Get the unsent data property. | |
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. | |
virtual bool | is_in_selection () |
Is this variable part of the current selection? | |
virtual bool | is_leaf_sequence () |
virtual bool | is_linear () |
Check to see whether this variable can be printed simply. | |
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 () |
string | name () const |
Returns the name of the class instance. | |
virtual int | number_of_rows () |
Sequence & | operator= (const Sequence &rhs) |
virtual bool | ops (BaseType *b, int op) |
Evaluate relational operators. | |
virtual void | print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) |
Print an ASCII representation of the variable structure. | |
virtual void | print_one_row (ostream &out, int row, string space, bool print_row_num=false) |
virtual void | print_val (ostream &out, string space="", bool print_decl_p=true) |
Prints the value of the variable. | |
virtual void | print_val_by_rows (ostream &out, string space="", bool print_decl_p=true, bool print_row_numbers=true) |
virtual void | print_xml (ostream &out, string space=" ", bool constrained=false) |
virtual BaseType * | ptr_duplicate () |
virtual bool | read () |
Read data into a local buffer. | |
virtual bool | read_p () |
Has this variable been read? | |
virtual bool | read_row (int row, DDS &dds, ConstraintEvaluator &eval, bool ce_eval=true) |
void | reset_row_number () |
Rest the row number counter. | |
virtual BaseTypeRow * | row_value (size_t row) |
Get a whole row from the sequence. | |
virtual bool | send_p () |
Should this variable be sent? | |
Sequence (const string &n) | |
The Sequence constructor. | |
Sequence (const string &n, const string &d) | |
The Sequence server-side constructor. | |
Sequence (const Sequence &rhs) | |
The Sequence copy constructor. | |
virtual bool | serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
virtual void | set_leaf_p (bool state) |
virtual void | set_leaf_sequence (int lvl=1) |
Mark the Sequence which holds the leaf elements. | |
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) |
Sets the value of the read_p property. | |
virtual void | set_row_number_constraint (int start, int stop, int stride=1) |
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. | |
void | set_unsent_data (bool usd) |
Set the unsent data property. | |
virtual void | set_value (SequenceValues &values) |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable *at_container) |
Type | type () const |
Returns the type of the class instance. | |
string | type_name () const |
Returns the type of the class instance as a string. | |
virtual unsigned int | val2buf (void *val, bool reuse=false) |
virtual SequenceValues | value () |
virtual BaseType * | var (const string &n, btp_stack &s) |
virtual BaseType * | var (const string &name, bool exact_match=true, btp_stack *s=0) |
Returns a pointer to a member of a constructor class. | |
Vars_iter | var_begin () |
Vars_iter | var_end () |
Vars_riter | var_rbegin () |
Vars_riter | var_rend () |
virtual BaseType * | var_value (size_t row, size_t i) |
Get the BaseType pointer to the $i^{th}$ variable of row. | |
virtual BaseType * | var_value (size_t row, const string &name) |
Get the BaseType pointer to the named variable of a given row. | |
virtual unsigned int | width () |
Returns the size of the class instance data. | |
virtual | ~Sequence () |
Protected Types | |
typedef stack< SequenceValues * > | sequence_values_stack_t |
Protected Member Functions | |
void | _duplicate (const Constructor &s) |
void | _duplicate (const BaseType &bt) |
Perform a deep copy. | |
virtual void | intern_data_for_leaf (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | intern_data_parent_part_one (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | intern_data_parent_part_two (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | intern_data_private (ConstraintEvaluator &eval, DDS &dds, sequence_values_stack_t &sequence_values_stack) |
virtual bool | serialize_leaf (DDS &dds, ConstraintEvaluator &eval, Marshaller &m, bool ce_eval) |
virtual bool | serialize_parent_part_one (DDS &dds, ConstraintEvaluator &eval, Marshaller &m) |
virtual void | serialize_parent_part_two (DDS &dds, ConstraintEvaluator &eval, Marshaller &m) |
Protected Attributes | |
std::vector< BaseType * > | _vars |
Friends | |
class | SequenceTest |
This is the interface for the class Sequence. A sequence contains a single set of variables, all at the same lexical level just like a Structure. Like a Structure, a Sequence may contain other compound types, including other Sequences. Unlike a Structure, a Sequence defines a pattern that is repeated N times for a sequence of N elements. It is useful to think of a Sequence as representing a table of values (like a relational database), with each row of the table corresponding to a Sequence ``instance.'' (This usage can be confusing, since ``instance'' also refers to a particular item of class Sequence.) For example:
Sequence { String name; Int32 age; } person;
This represents a Sequence of ``person'' records, each instance of which contains a name and an age:
Fred 34 Ralph 23 Andrea 29 ...
A Sequence can be arbitrarily long, which is to say that its length is not part of its declaration. A Sequence can contain other Sequences:
Sequence { String name; Int32 age; Sequence { String friend; } friend_list; } person;
This is still represented as a single table, but each row contains the elements of both the main Sequence and the nested one:
Fred 34 Norman Fred 34 Andrea Fred 34 Ralph Fred 34 Lisa Ralph 23 Norman Ralph 23 Andrea Ralph 23 Lisa Ralph 23 Marth Ralph 23 Throckmorton Ralph 23 Helga Ralph 23 Millicent Andrea 29 Ralph Andrea 29 Natasha Andrea 29 Norman ... .. ...
Internally, the Sequence is represented by a vector of vectors. The members of the outer vector are the members of the Sequence. This includes the nested Sequences, as in the above example.
NB: Note that in the past this class had a different behavior. It held only one row at a time and the deserialize(...) method had to be called from within a loop. This is no longer true. Now the deserailize(...) method should be called once and will read the entire sequence's values from the server. All the values are now stored in an instance of Sequence, not just a single row's.
Because the length of a Sequence is indeterminate, there are changes to the behavior of the functions to read this class of data. The read()
function for Sequence must be written so that successive calls return values for successive rows of the Sequence.
Similar to a C structure, you refer to members of Sequence elements with a ``.'' notation. For example, if the Sequence has a member Sequence called ``Tom'' and Tom has a member Float32 called ``shoe_size'', you can refer to Tom's shoe size as ``Tom.shoe_size''.
Definition at line 173 of file Sequence.h.
typedef stack<BaseType *> libdap::BaseType::btp_stack [inherited] |
Definition at line 214 of file BaseType.h.
typedef stack<SequenceValues*> libdap::Sequence::sequence_values_stack_t [protected] |
Definition at line 219 of file Sequence.h.
typedef std::vector<BaseType *>::const_iterator libdap::Constructor::Vars_citer [inherited] |
Definition at line 60 of file Constructor.h.
typedef std::vector<BaseType *>::iterator libdap::Constructor::Vars_iter [inherited] |
Definition at line 61 of file Constructor.h.
typedef std::vector<BaseType *>::reverse_iterator libdap::Constructor::Vars_riter [inherited] |
Definition at line 62 of file Constructor.h.
libdap::Sequence::Sequence | ( | const string & | n | ) |
The Sequence 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 162 of file Sequence.cc.
Referenced by buf2val(), ptr_duplicate(), and val2buf().
libdap::Sequence::Sequence | ( | const string & | n, |
const string & | d | ||
) |
The Sequence server-side constructor requires the name of the variable to be created and the dataset name from which this variable is being created.
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 179 of file Sequence.cc.
libdap::Sequence::Sequence | ( | const Sequence & | rhs | ) |
Definition at line 188 of file Sequence.cc.
libdap::Sequence::~Sequence | ( | ) | [virtual] |
Definition at line 216 of file Sequence.cc.
References libdap::Constructor::_vars, and DBG2.
void libdap::Constructor::_duplicate | ( | const Constructor & | s | ) | [protected, inherited] |
Definition at line 57 of file Constructor.cc.
Referenced by libdap::Constructor::operator=().
void libdap::BaseType::_duplicate | ( | const BaseType & | bt | ) | [protected, inherited] |
Perform a deep copy. Copies the values of bt into *this
. Pointers are dereferenced and their values are copied into a newly allocated instance.
bt | The source object. |
Definition at line 80 of file BaseType.cc.
References DBG.
Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().
Remember that if you wish to add a member to a nested Sequence, you must use the add_var()
of that Sequence. This means that variable names need not be unique among a set of nested Sequences.
bt | A pointer to the DAP2 type variable to add to this Sequence. |
part | defaults to nil |
Reimplemented from libdap::BaseType.
Definition at line 340 of file Sequence.cc.
References libdap::Constructor::_vars, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().
unsigned int libdap::Sequence::buf2val | ( | void ** | val | ) | [virtual] |
Never use this interface for Sequence! Use Sequence::var_value() or Sequence::row_value().
Implements libdap::BaseType.
Definition at line 1283 of file Sequence.cc.
References Sequence().
bool libdap::Sequence::check_semantics | ( | string & | msg, |
bool | all = false |
||
) | [virtual] |
This function checks the class instance for internal consistency. This is important to check for complex constructor classes. For BaseType, an object is semantically correct if it has both a non-null name and type.
For example, an Int32 instance would return FALSE if it had no name or no type defined. A Grid instance might return FALSE for more complex reasons, such as having Map arrays of the wrong size or shape.
This function is used by the DDS class, and will rarely, if ever, be explicitly called by a DODS application program. A variable must pass this test before it is sent, but there may be many other stages in a retrieve operation where it would fail.
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.
Definition at line 1443 of file Sequence.cc.
References libdap::Constructor::_vars, libdap::BaseType::check_semantics(), libdap::BaseType::name(), libdap::BaseType::type_name(), and libdap::unique_names().
string libdap::BaseType::dataset | ( | ) | const [inherited] |
A dataset from which the data is to be read. The meaning of this string will vary among different types of data sources. It may be the name of a data file or an identifier used to read data from a relational database.
Definition at line 231 of file BaseType.cc.
Referenced by read_row(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Structure::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
bool libdap::Sequence::deserialize | ( | UnMarshaller & | um, |
DDS * | dds, | ||
bool | reuse = false |
||
) | [virtual] |
This method used to read a single row at a time. Now the entire sequence is read at once. The method used to return True to indicate that more data needed to be deserialized and False when the sequence was completely read. Now it simply returns false. This might seem odd, but making this method return false breaks existing software the least.
um | An UnMarshaller that knows how to deserialize data |
dds | A DataDDS from which to read. |
reuse | Passed to child objects when they are deserialized. Some implementations of derialize() use this to determine if new storage should be allocated or existing storage reused. |
Error | if a sequence stream marker cannot be read. |
InternalErr | if the dds param is not a DataDDS. |
Implements libdap::BaseType.
Definition at line 1153 of file Sequence.cc.
References libdap::Constructor::_vars, DBG2, libdap::BaseType::deserialize(), libdap::DataDDS::get_protocol(), libdap::DataDDS::get_protocol_major(), libdap::DataDDS::get_protocol_minor(), libdap::BaseType::name(), libdap::BaseType::print_val(), and libdap::BaseType::ptr_duplicate().
void libdap::Sequence::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 libdap::Constructor.
Definition at line 1541 of file Sequence.cc.
References libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().
int libdap::Sequence::element_count | ( | bool | leaves = false | ) | [virtual] |
Return a count of the total number of variables in this variable. This is used to count the number of variables held by a constructor variable - for simple type and vector variables it always returns 1.
For compound data types, there are two ways to count members. You can count the members, or you can count the simple members and add that to the count of the compound members. For example, if a Structure contains an Int32 and another Structure that itself contains two Int32 members, the element count of the top-level structure could be two (one Int32 and one Structure) or three (one Int32 by itself and two Int32's in the subsidiary Structure). Use the leaves parameter to control which kind of counting you desire.
leaves | This parameter is only relevant if the object contains other compound data types. If FALSE, the function counts only the data variables mentioned in the object's declaration. If TRUE, it counts the simple members, and adds that to the sum of the counts for the compound members. This parameter has no effect for simple type variables. |
Reimplemented from libdap::BaseType.
Definition at line 258 of file Sequence.cc.
References libdap::Constructor::_vars.
Referenced by print_one_row().
AttrTable & libdap::BaseType::get_attr_table | ( | ) | [virtual, inherited] |
Get this variable's AttrTable. It's generally a bad idea to return a reference to a contained object, but in this case it seems that building an interface inside BaseType is overkill.
Use the AttrTable methods to manipulate the table.
Definition at line 531 of file BaseType.cc.
Referenced by libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), libdap::Grid::transfer_attributes(), libdap::Constructor::transfer_attributes(), and libdap::BaseType::transfer_attributes().
int libdap::Sequence::get_ending_row_number | ( | ) | [virtual] |
Return the ending row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1245 of file Sequence.cc.
Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().
BaseType * libdap::BaseType::get_parent | ( | ) | [virtual, inherited] |
Return a pointer to the Constructor or Vector which holds (contains) this variable. If this variable is at the top level, this method returns null.
Definition at line 655 of file BaseType.cc.
Referenced by libdap::function_linear_scale(), intern_data_for_leaf(), intern_data_parent_part_two(), serialize_leaf(), and serialize_parent_part_two().
int libdap::Sequence::get_row_stride | ( | ) | [virtual] |
Return the row stride number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row stride is applied to the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1228 of file Sequence.cc.
Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().
int libdap::Sequence::get_starting_row_number | ( | ) |
Return the starting row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1212 of file Sequence.cc.
Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().
bool libdap::Sequence::get_unsent_data | ( | ) | [inline] |
Definition at line 295 of file Sequence.h.
Referenced by intern_data_parent_part_two().
BaseType * libdap::Constructor::get_var_index | ( | int | i | ) | [inherited] |
Return the BaseType pointer for the ith variable.
i | This index |
Definition at line 328 of file Constructor.cc.
References libdap::Constructor::_vars.
Constructor::Vars_iter libdap::Constructor::get_vars_iter | ( | int | i | ) | [inherited] |
Return the iterator for the ith variable.
i | the index |
Definition at line 319 of file Constructor.cc.
References libdap::Constructor::_vars.
void libdap::Sequence::intern_data | ( | ConstraintEvaluator & | eval, |
DDS & | dds | ||
) | [virtual] |
This method is used to evaluate a constraint and based on those results load the Sequence variable with data. This simulates having a server call the serialize() method and a client call the deserialize() method without the overhead of any IPC. Use this method on the server-side to 'load the d_values field with data' so that other code and work with those data.
The somewhat odd algorithm used by serialize() is largely copied here, so comments about logic in serialize() and the related methods apply here as well.
eval | Use this contraint evaluator |
dds | This DDS holds the variables for the data source |
Reimplemented from libdap::BaseType.
Definition at line 928 of file Sequence.cc.
References DBG, DBG2, intern_data_private(), and libdap::BaseType::name().
void libdap::Sequence::intern_data_for_leaf | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
sequence_values_stack_t & | sequence_values_stack | ||
) | [protected, virtual] |
Definition at line 1074 of file Sequence.cc.
References DBG, DBG2, libdap::dods_sequence_c, get_ending_row_number(), libdap::BaseType::get_parent(), get_row_stride(), get_starting_row_number(), intern_data_parent_part_two(), libdap::BaseType::name(), read_row(), set_read_p(), libdap::BaseType::type(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Referenced by intern_data_private().
void libdap::Sequence::intern_data_parent_part_one | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
sequence_values_stack_t & | sequence_values_stack | ||
) | [protected, virtual] |
Definition at line 959 of file Sequence.cc.
References DBG, DBG2, libdap::dods_sequence_c, get_ending_row_number(), get_row_stride(), get_starting_row_number(), intern_data_private(), libdap::BaseType::name(), read_row(), reset_row_number(), set_read_p(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Referenced by intern_data_private().
void libdap::Sequence::intern_data_parent_part_two | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
sequence_values_stack_t & | sequence_values_stack | ||
) | [protected, virtual] |
Definition at line 1024 of file Sequence.cc.
References DBG, DBG2, libdap::dods_sequence_c, libdap::BaseType::get_parent(), get_unsent_data(), intern_data_parent_part_two(), libdap::BaseType::name(), set_unsent_data(), libdap::BaseType::type(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Referenced by intern_data_for_leaf(), and intern_data_parent_part_two().
void libdap::Sequence::intern_data_private | ( | ConstraintEvaluator & | eval, |
DDS & | dds, | ||
sequence_values_stack_t & | sequence_values_stack | ||
) | [protected, virtual] |
Definition at line 946 of file Sequence.cc.
References DBG, intern_data_for_leaf(), intern_data_parent_part_one(), is_leaf_sequence(), and libdap::BaseType::name().
Referenced by intern_data(), and intern_data_parent_part_one().
bool libdap::BaseType::is_constructor_type | ( | ) | [virtual, inherited] |
Definition at line 356 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::DDXParser::ddx_sax2_end_element(), libdap::DDS::leaf_match(), and libdap::Vector::var().
bool libdap::BaseType::is_in_selection | ( | ) | [virtual, inherited] |
Does this variable appear in either the selection part or as a function argument in the current constrain expression. If this property is set (true) then implementations of the read() method should read this variable.
Definition at line 610 of file BaseType.cc.
bool libdap::Sequence::is_leaf_sequence | ( | ) | [virtual] |
Definition at line 1468 of file Sequence.cc.
Referenced by intern_data_private(), serialize(), and set_leaf_sequence().
bool libdap::Sequence::is_linear | ( | ) | [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 272 of file Sequence.cc.
References libdap::Constructor::_vars, libdap::dods_sequence_c, and libdap::dods_structure_c.
bool libdap::BaseType::is_simple_type | ( | ) | [virtual, inherited] |
Definition at line 295 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().
bool libdap::BaseType::is_vector_type | ( | ) | [virtual, inherited] |
Definition at line 324 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().
Referenced by libdap::DDXParser::ddx_sax2_end_element(), and libdap::DDS::leaf_match().
int libdap::Sequence::length | ( | ) | [virtual] |
Returns the number of elements in a Sequence object. Note that this is not the number of items in a row, but the number of rows in the complete sequence object. To be meaningful, this must be computed after constraint expresseion (CE) evaluation. The purpose of this function is to facilitate translations between Sequence objects and Array objects, particularly when the Sequence is too large to be transferred from the server to the client in its entirety.
This function, to be useful, must be specialized for the API and data format in use.
Definition at line 532 of file Sequence.cc.
string libdap::BaseType::name | ( | ) | const [inherited] |
Definition at line 210 of file BaseType.cc.
Referenced by libdap::Structure::_duplicate(), libdap::Vector::add_var(), libdap::Structure::check_semantics(), check_semantics(), libdap::Grid::check_semantics(), deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), libdap::GSEClause::get_map_name(), libdap::GridGeoConstraint::GridGeoConstraint(), libdap::GSEClause::GSEClause(), libdap::Vector::intern_data(), libdap::Structure::intern_data(), intern_data(), libdap::BaseType::intern_data(), intern_data_for_leaf(), intern_data_parent_part_one(), intern_data_parent_part_two(), intern_data_private(), libdap::DDS::leaf_match(), libdap::DDS::mark(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::Array::print_xml_core(), read_row(), libdap::DODSFilter::send_data_ddx(), libdap::Str::serialize(), serialize(), serialize_leaf(), serialize_parent_part_one(), serialize_parent_part_two(), set_leaf_sequence(), libdap::BaseType::set_name(), libdap::BaseType::set_read_p(), libdap::BaseType::set_send_p(), libdap::Grid::transfer_attributes(), libdap::Constructor::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::rvalue::value_name(), libdap::Vector::var(), libdap::Structure::var(), var(), libdap::Grid::var(), and var_value().
int libdap::Sequence::number_of_rows | ( | ) | [virtual] |
Definition at line 539 of file Sequence.cc.
Referenced by print_val_by_rows().
Definition at line 229 of file Sequence.cc.
bool libdap::BaseType::ops | ( | BaseType * | b, |
int | op | ||
) | [virtual, inherited] |
This method contains the relational operators used by the constraint expression evaluator in the DDS class. Each class that wants to be able to evaluate relational expressions must overload this function. The implementation in BaseType throws an InternalErr exception. The DAP library classes Byte, ..., Url provide specializations of this method. It is not meaningful for classes such as Array because relational expressions using Array are not supported.
The op argument refers to a table generated by bison from the constraint expression parser. Use statements like the following to correctly interpret its value:
switch (op) { case EQUAL: return i1 == i2; case NOT_EQUAL: return i1 != i2; case GREATER: return i1 > i2; case GREATER_EQL: return i1 >= i2; case LESS: return i1 < i2; case LESS_EQL: return i1 <= i2; case REGEXP: throw Error("Regular expressions are not supported for integer values"); default: throw Error("Unknown operator"); }
This function is used by the constraint expression evaluator.
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::Byte, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Str, libdap::UInt16, and libdap::UInt32.
Definition at line 1081 of file BaseType.cc.
Referenced by libdap::Clause::value().
void libdap::Constructor::print_decl | ( | ostream & | out, |
string | space = " " , |
||
bool | print_semi = true , |
||
bool | constraint_info = false , |
||
bool | constrained = false |
||
) | [virtual, inherited] |
Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.
A simple array declaration might look like this:
Float64 lat[lat = 180];
While a more complex declaration (for a Grid, in this case), would look like this:
Grid { ARRAY: Int32 sst[time = 404][lat = 180][lon = 360]; MAPS: Float64 time[time = 404]; Float64 lat[lat = 180]; Float64 lon[lon = 360]; } sst;
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 361 of file Constructor.cc.
References libdap::Constructor::_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().
Referenced by libdap::Structure::print_val(), and print_val_by_rows().
void libdap::Sequence::print_one_row | ( | ostream & | out, |
int | row, | ||
string | space, | ||
bool | print_row_num = false |
||
) | [virtual] |
Definition at line 1330 of file Sequence.cc.
References libdap::dods_sequence_c, element_count(), libdap::BaseType::print_val(), libdap::BaseType::type(), and var_value().
Referenced by print_val_by_rows().
void libdap::Sequence::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 libdap::BaseType.
Definition at line 1436 of file Sequence.cc.
References print_val_by_rows().
void libdap::Sequence::print_val_by_rows | ( | ostream & | out, |
string | space = "" , |
||
bool | print_decl_p = true , |
||
bool | print_row_numbers = true |
||
) | [virtual] |
Definition at line 1403 of file Sequence.cc.
References number_of_rows(), libdap::Constructor::print_decl(), and print_one_row().
Referenced by print_val().
void libdap::Constructor::print_xml | ( | ostream & | out, |
string | space = " " , |
||
bool | constrained = false |
||
) | [virtual, inherited] |
Write the XML representation of this variable. This method is used to build the DDX XML response.
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.
Definition at line 448 of file Constructor.cc.
References libdap::BaseType::get_attr_table(), libdap::id2xml(), libdap::BaseType::name(), libdap::AttrTable::print_xml(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
BaseType * libdap::Sequence::ptr_duplicate | ( | ) | [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 194 of file Sequence.cc.
References Sequence().
bool libdap::BaseType::read | ( | ) | [virtual, inherited] |
This method should be implemented for each of the data type classes (Byte, ..., Grid) when using the DAP class library to build a server. This method is only for DAP servers. The library provides a default definition here which throws an InternalErr exception unless the read_p property has been set. In that case it returns false, indicating that all the data have been read. The latter case can happen when building a constant value that needs to be passed to a function. The variable/constant is loaded with a value when it is created.
When implementing a new DAP server, the Byte, ..., Grid data type classes are usually specialized. In each of those specializations read() should be defined to read values from the data source and store them in the object's local buffer. The read() method is called by other methods in this library. When writing read(), follow these rules:
read_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. For Sequence::read(), your specialization must correctly manage the unsent_data
property and row count in addition to the read_p
property (handle the read_p
property as describe above). For a Sequence to serialize correctly, once all data from the Sequence has been read, unsent_data
property must be set to false (use Sequence::set_unsent_data()). Also, at that time the row number counter must be reset (use Sequence::reset_row_counter()). Typically the correct time to set unsent_data
to false and reset the row counter is the time when Sequence::read() return false indicating that all the data for the Sequence have been read. Failure to handle these tasks will break serialization of nested Sequences. Note that when Sequence::read() returns with a result of true (indicating there is more data to send, the value of the unsent_data
property should be true.
Also, if you server must handle nested sequences, be sure to read about subclassing set_read_p().
Reimplemented in libdap::Structure.
Definition at line 790 of file BaseType.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), libdap::ArrayGeoConstraint::apply_constraint_to_data(), libdap::GeoConstraint::flip_latitude_within_array(), libdap::function_geogrid(), libdap::function_grid(), libdap::function_linear_scale(), libdap::Vector::intern_data(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), read_row(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), and libdap::Byte::serialize().
bool libdap::BaseType::read_p | ( | ) | [virtual, inherited] |
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 444 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::Vector::intern_data(), libdap::Structure::intern_data(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), libdap::Structure::read(), read_row(), libdap::Vector::serialize(), libdap::UInt32::serialize(), libdap::UInt16::serialize(), libdap::Structure::serialize(), libdap::Str::serialize(), libdap::Int32::serialize(), libdap::Int16::serialize(), libdap::Grid::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), libdap::Byte::serialize(), and libdap::Vector::set_value_slice_from_row_major_vector().
bool libdap::Sequence::read_row | ( | int | row, |
DDS & | dds, | ||
ConstraintEvaluator & | eval, | ||
bool | ce_eval = true |
||
) | [virtual] |
Read row number row of the Sequence. The values of the row are obtained by calling the read() method of the sequence. The current row just read is stored in the Sequence instance along with its row number. If a selection expression has been supplied, rows are counted only if they satisfy that expression.
Note that we can only advance in a Sequence. It is not possible to back up and read a row numbered lower than the current row. If you need that you will need to replace the serialize() method with one of your own.
Used on the server side.
row | The row number to read. |
dds | A reference to the DDS for this dataset. |
eval | Use this as the constraint expression evaluator. |
ce_eval | If True, evaluate any CE, otherwise do not. |
Definition at line 606 of file Sequence.cc.
References libdap::BaseType::dataset(), DBG2, libdap::ConstraintEvaluator::eval_selection(), libdap::BaseType::name(), libdap::BaseType::read(), libdap::BaseType::read_p(), set_read_p(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().
Referenced by intern_data_for_leaf(), intern_data_parent_part_one(), serialize_leaf(), and serialize_parent_part_one().
void libdap::Sequence::reset_row_number | ( | ) |
When reading a nested sequence, use this method to reset the internal row number counter. This is necessary so that the second, ... instances of the inner/nested sequence will start off reading row zero.
Definition at line 548 of file Sequence.cc.
Referenced by intern_data_parent_part_one().
BaseTypeRow * libdap::Sequence::row_value | ( | size_t | row | ) | [virtual] |
row | Get row number row from the sequence. |
Definition at line 433 of file Sequence.cc.
Referenced by var_value().
bool libdap::BaseType::send_p | ( | ) | [virtual, inherited] |
Returns the state of the send_p
property. If true, this variable should be sent to the client, if false, it should not. If no constraint expression (CE) has been evaluated, this property is true for all variables in a data source (i.e., for all the variables listed in a DDS). If a CE has been evaluated, this property is true only for those variables listed in the projection part of the CE.
Definition at line 503 of file BaseType.cc.
Referenced by libdap::Grid::components(), libdap::Grid::intern_data(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::BaseType::print_decl(), libdap::Array::print_decl(), libdap::Grid::print_val(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), libdap::Grid::projection_yields_grid(), and libdap::Grid::serialize().
bool libdap::Sequence::serialize | ( | ConstraintEvaluator & | eval, |
DDS & | dds, | ||
Marshaller & | m, | ||
bool | ce_eval = true |
||
) | [virtual] |
Serialize a Sequence.
Leaf Sequences must be marked as such (see DDS::tag_nested_sequence()), as must the top most Sequence.
How the code works. Methods called for various functions are named in brackets:
Sending a one-level sequence:
Dataset { Sequence { Int x; Int y; } flat; } case_1;
Serialize it by reading successive rows and sending all of those that satisfy the CE. Before each row, send a start of instance (SOI) marker. Once all rows have been sent, send an End of Sequence (EOS) marker.[serialize_leaf].
Sending a nested sequence:
Dataset { Sequence { Int t; Sequence { Int z; } inner; } outer; } case_2;
Serialize by reading the first row of outer and storing the values. Do not evaluate the CE [serialize_parent_part_one]. Call serialize() for inner and read each row for it, evaluating the CE for each row that is read. After the first row of inner is read and satisfies the CE, write out the SOI marker and values for outer [serialize_parent_part_two], then write the SOI and values for the first row of inner. Continue to read and send rows of inner until the last row has been read. Send EOS for inner [serialize_leaf]. Now read the next row of outer and repeat. Once outer is completely read, send its EOS marker.
Notes:
For a nested Sequence, the child sequence must follow all other types in the parent sequence (like the example). There may be only one nested Sequence per level.
CE evaluation happens only in a leaf sequence.
Implements libdap::BaseType.
Definition at line 726 of file Sequence.cc.
References DBG2, is_leaf_sequence(), libdap::BaseType::name(), serialize_leaf(), and serialize_parent_part_one().
bool libdap::Sequence::serialize_leaf | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
Marshaller & | m, | ||
bool | ce_eval | ||
) | [protected, virtual] |
Definition at line 841 of file Sequence.cc.
References libdap::Constructor::_vars, DBG, libdap::dods_sequence_c, libdap::BaseType::get_parent(), libdap::BaseType::name(), read_row(), set_read_p(), and libdap::BaseType::type().
Referenced by serialize().
bool libdap::Sequence::serialize_parent_part_one | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
Marshaller & | m | ||
) | [protected, virtual] |
Definition at line 743 of file Sequence.cc.
References libdap::Constructor::_vars, DBG, DBG2, libdap::dods_sequence_c, libdap::BaseType::name(), read_row(), and set_read_p().
Referenced by serialize().
void libdap::Sequence::serialize_parent_part_two | ( | DDS & | dds, |
ConstraintEvaluator & | eval, | ||
Marshaller & | m | ||
) | [protected, virtual] |
Definition at line 809 of file Sequence.cc.
References libdap::Constructor::_vars, DBG, libdap::dods_sequence_c, libdap::BaseType::get_parent(), libdap::BaseType::name(), and libdap::BaseType::type().
void libdap::BaseType::set_attr_table | ( | const AttrTable & | at | ) | [virtual, inherited] |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 539 of file BaseType.cc.
void libdap::Sequence::set_in_selection | ( | bool | state | ) | [virtual] |
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. |
Reimplemented from libdap::BaseType.
Definition at line 321 of file Sequence.cc.
References libdap::Constructor::_vars.
void libdap::Sequence::set_leaf_p | ( | bool | state | ) | [virtual] |
Definition at line 1462 of file Sequence.cc.
Referenced by set_leaf_sequence().
void libdap::Sequence::set_leaf_sequence | ( | int | lvl = 1 | ) | [virtual] |
In a nested Sequence, the Sequence which holds the leaf elements is special because it during the serialization of this Sequence's data that constraint Expressions must be evaluated. If CEs are evaluated at the upper levels, then valid data may not be sent because it was effectlively hidden from the serialization and evaluation code (see the documentatin for the serialize_leaf() method).
The notion of the leaf Sequence needs to be modified to mean the lowest level of a Sequence where data are to be sent. Suppose there's a two level Sequence, but that only fields from the top level are to be sent. Then that top level is also the leaf Sequence and should be marked as such. If the lower level is marked as a leaf Sequence, then no values will ever be sent since the send_p property will always be false for each field and it's the call to serialize_leaf() that actually triggers transmission of values (because it's not until the code makes it into serialize_leaf() that it knows there are values to be sent.
lvl | The current level of the Sequence. a lvl of 1 indicates the topmost Sequence. The default value is 1. |
Definition at line 1498 of file Sequence.cc.
References libdap::Constructor::_vars, DBG2, libdap::dods_sequence_c, libdap::dods_structure_c, is_leaf_sequence(), libdap::BaseType::name(), set_leaf_p(), libdap::Structure::set_leaf_sequence(), and set_leaf_sequence().
Referenced by set_leaf_sequence().
void libdap::BaseType::set_name | ( | const string & | n | ) | [virtual, inherited] |
Definition at line 217 of file BaseType.cc.
References libdap::BaseType::name(), and libdap::www2id().
Referenced by libdap::Vector::add_var(), libdap::Array::print_xml_core(), and libdap::Vector::set_name().
void libdap::BaseType::set_parent | ( | BaseType * | parent | ) | [virtual, inherited] |
Set the parent
property for this variable. Only instances of Constructor or Vector should call this method.
parent | Pointer to the Constructor of Vector parent variable. |
InternalErr | thrown if called with anything other than a Constructor or Vector. |
Definition at line 638 of file BaseType.cc.
Referenced by libdap::Vector::_duplicate(), libdap::Structure::_duplicate(), libdap::Grid::_duplicate(), libdap::Grid::add_map(), libdap::Vector::add_var(), libdap::Structure::add_var(), add_var(), libdap::Grid::add_var(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().
void libdap::Sequence::set_read_p | ( | bool | state | ) | [virtual] |
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.
Definition at line 311 of file Sequence.cc.
References libdap::Constructor::_vars.
Referenced by intern_data_for_leaf(), intern_data_parent_part_one(), read_row(), serialize_leaf(), and serialize_parent_part_one().
void libdap::Sequence::set_row_number_constraint | ( | int | start, |
int | stop, | ||
int | stride = 1 |
||
) | [virtual] |
Set the start, stop and stride for a row-number type constraint. This should be used only when the sequence is constrained using the bracket notation (which supplies start, stride and stop information). If omitted, the stride defaults to 1.
start | The starting row number. The first row is row zero. |
stop | The eding row number. The 20th row is row 19. |
stride | The stride. A stride of two skips every other row. |
Definition at line 1259 of file Sequence.cc.
References malformed_expr.
void libdap::Sequence::set_send_p | ( | bool | state | ) | [virtual] |
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 _send_p
and _read_p
flags are set to TRUE.
state | The logical state to set the send_p flag. |
Reimplemented from libdap::BaseType.
Definition at line 301 of file Sequence.cc.
References libdap::Constructor::_vars.
void libdap::BaseType::set_synthesized_p | ( | bool | state | ) | [virtual, inherited] |
Set the synthesized flag. Before setting this flag be sure to set the read_p()
state. Once this flag is set you cannot alter the state of the read_p
flag!
Definition at line 427 of file BaseType.cc.
void libdap::BaseType::set_type | ( | const Type & | t | ) | [inherited] |
Definition at line 245 of file BaseType.cc.
Referenced by libdap::Url::Url().
void libdap::Sequence::set_unsent_data | ( | bool | usd | ) | [inline] |
Definition at line 301 of file Sequence.h.
Referenced by intern_data_parent_part_two().
void libdap::Sequence::set_value | ( | SequenceValues & | values | ) | [virtual] |
Set value of this Sequence. This does not perform a deep copy, so data should be allocated on the heap and freed only when the Sequence dtor is called.
values | Set the value of this Sequence. |
Definition at line 447 of file Sequence.cc.
bool libdap::BaseType::synthesized_p | ( | ) | [virtual, inherited] |
Returns true if the variable is a synthesized variable. A synthesized variable is one that is added to the dataset by the server (usually with a `projection function'.
Definition at line 416 of file BaseType.cc.
string libdap::Sequence::toString | ( | ) | [virtual] |
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 from libdap::BaseType.
Definition at line 242 of file Sequence.cc.
References libdap::Constructor::_vars.
void libdap::Constructor::transfer_attributes | ( | AttrTable * | at_container | ) | [virtual, inherited] |
Given an Attribute table, scavenge attributes from it and load them into this object and the variables it contains.
This implementation differes from the version in BaseType in that each of the children of the Constructor are passed an attribute container if one is found that matches the name of this Constructor variable.
at_containeer | Search for attributes in this container. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 260 of file Constructor.cc.
References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), 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::AttrTable::is_global_attribute(), libdap::BaseType::name(), libdap::AttrTable::set_is_global_attribute(), libdap::BaseType::var(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().
Type libdap::BaseType::type | ( | ) | const [inherited] |
Definition at line 238 of file BaseType.cc.
Referenced by libdap::Array::add_var(), libdap::Vector::buf2val(), libdap::Grid::check_semantics(), libdap::Vector::deserialize(), libdap::Vector::dump(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), libdap::function_linear_scale(), libdap::XDRStreamUnMarshaller::get_vector(), libdap::XDRFileUnMarshaller::get_vector(), libdap::Vector::intern_data(), intern_data_for_leaf(), intern_data_parent_part_two(), libdap::Vector::is_cardinal_type(), libdap::BaseType::is_constructor_type(), libdap::BaseType::is_simple_type(), libdap::BaseType::is_vector_type(), libdap::UInt32::ops(), libdap::UInt16::ops(), libdap::Str::ops(), libdap::Int32::ops(), libdap::Int16::ops(), libdap::Float64::ops(), libdap::Float32::ops(), libdap::Byte::ops(), print_one_row(), libdap::XDRStreamMarshaller::put_vector(), libdap::XDRFileMarshaller::put_vector(), libdap::Vector::reserve_value_capacity(), libdap::Vector::serialize(), serialize_leaf(), 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().
string libdap::BaseType::type_name | ( | ) | const [inherited] |
Definition at line 252 of file BaseType.cc.
References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, and libdap::dods_url_c.
Referenced by libdap::Vector::add_var(), libdap::Structure::check_semantics(), check_semantics(), libdap::Vector::deserialize(), libdap::BaseType::dump(), libdap::DDS::mark(), libdap::Grid::print_decl(), libdap::Constructor::print_decl(), libdap::BaseType::print_decl(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::BaseType::toString().
unsigned int libdap::Sequence::val2buf | ( | void * | val, |
bool | reuse = false |
||
) | [virtual] |
Never use this interface for Sequence! To add data to the members of a Sequence, use BaseTypeRow variables and operate on them individually.
Implements libdap::BaseType.
Definition at line 1272 of file Sequence.cc.
References Sequence().
SequenceValues libdap::Sequence::value | ( | ) | [virtual] |
Get the value for this sequence.
Definition at line 455 of file Sequence.cc.
This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as BaseType::var(const string &, bool, btp_stack *) 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.
Reimplemented from libdap::BaseType.
Definition at line 355 of file Sequence.cc.
References libdap::BaseType::name(), and libdap::www2id().
BaseType * libdap::Sequence::var | ( | const string & | name, |
bool | exact_match = true , |
||
btp_stack * | s = 0 |
||
) | [virtual] |
Returns a pointer to the contained variable in a composite class. The composite classes are those made up of aggregated simple data types. Array, Grid, and Structure are composite types, while Int and Float are simple types. This function is only used by composite classes. The BaseType implementation always returns null.
Several of the subclasses provide alternate access methods that make sense for that particular data type. For example, the Array class defines a *var(int i)
method that returns the ith entry in the Array data, and the Structure provides a *var(Vars_iter)
function using a pseudo-index to access the different members of the structure.
name | The name of the class member. Defaults to "" |
exact_match | True if only interested in variables whose full names match n exactly. If false, returns the first variable whose name matches name. For example, if name is x and point.x is a variable, then var("x", false) would return a BaseType pointer to point.x . If exact_match was true then name would need to be "point.x" for var to return that pointer. This feature simplifies constraint expressions for datasets which have complex, nested, constructor variables. Defaults to true. |
s | Record the path to name. Defaults to null, in which case it is not used. |
Reimplemented from libdap::BaseType.
Definition at line 367 of file Sequence.cc.
References libdap::www2id().
Constructor::Vars_iter libdap::Constructor::var_begin | ( | ) | [inherited] |
Returns an iterator referencing the first structure element.
Definition at line 101 of file Constructor.cc.
References libdap::Constructor::_vars.
Referenced by libdap::DDXParser::ddx_end_document(), intern_data_for_leaf(), intern_data_parent_part_one(), intern_data_parent_part_two(), libdap::Constructor::print_xml(), libdap::Structure::set_leaf_sequence(), and libdap::Constructor::transfer_attributes().
Constructor::Vars_iter libdap::Constructor::var_end | ( | ) | [inherited] |
Returns an iterator referencing the end of the list of structure elements. Does not reference the last structure element.
Definition at line 295 of file Constructor.cc.
References libdap::Constructor::_vars.
Referenced by libdap::DDXParser::ddx_end_document(), intern_data_for_leaf(), intern_data_parent_part_one(), intern_data_parent_part_two(), libdap::Constructor::print_xml(), libdap::Structure::set_leaf_sequence(), and libdap::Constructor::transfer_attributes().
Constructor::Vars_riter libdap::Constructor::var_rbegin | ( | ) | [inherited] |
Return a reverse iterator that references the last element.
Definition at line 302 of file Constructor.cc.
References libdap::Constructor::_vars.
Constructor::Vars_riter libdap::Constructor::var_rend | ( | ) | [inherited] |
Return a reverse iterator that references a point 'before' the first element.
Definition at line 310 of file Constructor.cc.
References libdap::Constructor::_vars.
BaseType * libdap::Sequence::var_value | ( | size_t | row, |
size_t | i | ||
) | [virtual] |
row | Read from row in the sequence. |
i | Return the $i^{th}$ variable from row. |
Definition at line 489 of file Sequence.cc.
References row_value().
BaseType * libdap::Sequence::var_value | ( | size_t | row, |
const string & | name | ||
) | [virtual] |
row | Read from row in the sequence. |
name | Return name from row. |
Definition at line 466 of file Sequence.cc.
References libdap::BaseType::name(), and row_value().
Referenced by print_one_row().
unsigned int libdap::Sequence::width | ( | ) | [virtual] |
Return the number of bytes that are required to hold the instance's value. In the case of simple types such as Int32, this is the size of one Int32 (four bytes). For a String or Url type, width()
returns the number of bytes needed for a String *
variable, not the bytes needed for all the characters, since that value cannot be determined from type information alone. For Structure, and other constructor types size() returns the number of bytes needed to store pointers to the C++ objects.
Implements libdap::BaseType.
Definition at line 502 of file Sequence.cc.
References libdap::Constructor::_vars.
friend class SequenceTest [friend] |
Definition at line 215 of file Sequence.h.
std::vector<BaseType *> libdap::Constructor::_vars [protected, inherited] |
Definition at line 48 of file Constructor.h.
Referenced by libdap::Structure::_duplicate(), libdap::Grid::add_map(), libdap::Structure::add_var(), add_var(), libdap::Grid::add_var(), libdap::Structure::check_semantics(), check_semantics(), libdap::Structure::del_var(), libdap::Structure::deserialize(), deserialize(), libdap::Constructor::dump(), libdap::Structure::element_count(), element_count(), libdap::Constructor::get_var_index(), libdap::Constructor::get_vars_iter(), libdap::Structure::intern_data(), libdap::Structure::is_linear(), is_linear(), libdap::Grid::prepend_map(), libdap::Constructor::print_decl(), libdap::Structure::print_val(), libdap::Structure::read(), libdap::Structure::serialize(), serialize_leaf(), serialize_parent_part_one(), serialize_parent_part_two(), libdap::Structure::set_in_selection(), set_in_selection(), set_leaf_sequence(), libdap::Structure::set_read_p(), set_read_p(), libdap::Structure::set_send_p(), set_send_p(), toString(), libdap::Constructor::var_begin(), libdap::Constructor::var_end(), libdap::Constructor::var_rbegin(), libdap::Constructor::var_rend(), libdap::Structure::width(), width(), ~Sequence(), and libdap::Structure::~Structure().