libdap
Updated for version 3.20.6
libdap4 is an implementation of OPeNDAP's DAP protocol.
|
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 *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... | |
virtual void | clear_local_data () |
virtual void | compute_checksum (Crc32 &checksum) |
include the data for this variable in the checksum DAP4 includes a checksum with every data response. This method adds the variable's data to that checksum. More... | |
virtual bool | d4_ops (BaseType *b, int op) |
Evaluator a relop for DAP4. More... | |
virtual 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 void | deserialize (D4StreamUnMarshaller &um, DMR &dmr) |
virtual bool | deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) |
Deserialize (read from the network) the entire Sequence. 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 std::string | FQN () const |
virtual AttrTable & | get_attr_table () |
virtual int | get_ending_row_number () |
Get the ending row number. More... | |
virtual BaseType * | get_parent () const |
int | get_row_number () const |
virtual int | get_row_stride () |
Get the row stride. More... | |
int | get_starting_row_number () |
Get the starting row number. More... | |
bool | get_unsent_data () const |
Get the unsent data property. More... | |
BaseType * | get_var_index (int i) |
Vars_iter | get_vars_iter (int i) |
void | increment_row_number (unsigned int i) |
virtual void | intern_data () |
Read data into this variable. More... | |
virtual void | intern_data (ConstraintEvaluator &eval, DDS &dds) |
virtual bool | is_constructor_type () const |
Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. More... | |
virtual bool | is_dap2_only_type () |
virtual bool | is_dap4 () const |
virtual bool | is_in_selection () |
Is this variable part of the current selection? More... | |
virtual bool | is_leaf_sequence () |
virtual bool | is_linear () |
Check to see whether this variable can be printed simply. More... | |
virtual bool | is_simple_type () const |
Returns true if the instance is a numeric, string or URL type variable. More... | |
virtual bool | is_vector_type () const |
Returns true if the instance is a vector (i.e., array) type variable. More... | |
virtual int | length () const |
virtual string | name () const |
Returns the name of the class instance. More... | |
virtual int | number_of_rows () const |
Sequence & | operator= (const Sequence &rhs) |
virtual bool | ops (BaseType *b, int op) |
Evaluate relational operators. More... | |
void | print_dap4 (XMLWriter &xml, bool constrained=false) |
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_one_row (ostream &out, int row, string space, bool print_row_num=false) |
virtual void | print_one_row (FILE *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. 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_by_rows (ostream &out, string space="", bool print_decl_p=true, bool print_row_numbers=true) |
virtual void | print_val_by_rows (FILE *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 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 | read_row (int row, DDS &dds, ConstraintEvaluator &eval, bool ce_eval=true) |
void | reset_row_number () |
Rest the row number counter. More... | |
void | reset_row_number (bool recur) |
A recursive version of reset_row_number() More... | |
virtual BaseTypeRow * | row_value (size_t row) |
Get a whole row from the sequence. More... | |
virtual bool | send_p () |
Should this variable be sent? More... | |
Sequence (const string &n) | |
The Sequence constructor. More... | |
Sequence (const string &n, const string &d) | |
The Sequence server-side constructor. More... | |
Sequence (const Sequence &rhs) | |
The Sequence copy constructor. More... | |
virtual void | serialize (D4StreamMarshaller &m, DMR &dmr, bool filter=false) |
Serialize a Constructor. More... | |
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) |
Set the in_selection property. More... | |
virtual void | set_is_dap4 (const bool v) |
virtual void | set_leaf_p (bool state) |
virtual void | set_leaf_sequence (int lvl=1) |
Mark the Sequence which holds the leaf elements. More... | |
virtual void | set_length (int) |
Set the number of elements for this variable. 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_row_number_constraint (int start, int stop, int stride=1) |
virtual void | set_send_p (bool state) |
virtual void | set_synthesized_p (bool state) |
virtual void | set_type (const Type &t) |
Sets the type of the class instance. More... | |
void | set_unsent_data (bool usd) |
Set the unsent data property. More... | |
virtual void | set_value (SequenceValues &values) |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable *at) |
virtual std::vector< BaseType * > * | transform_to_dap2 (AttrTable *parent_attr_table) |
DAP4 to DAP2 transform. More... | |
virtual void | transform_to_dap4 (D4Group *root, Constructor *container) |
virtual Type | type () const |
Returns the type of the class instance. More... | |
virtual 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 SequenceValues | value () |
virtual SequenceValues & | value_ref () |
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 BaseType * | var_value (size_t row, const string &name) |
Get the BaseType pointer to the named variable of a given row. More... | |
virtual BaseType * | var_value (size_t row, size_t i) |
Get the BaseType pointer to the $i^{th}$ variable of row. More... | |
virtual unsigned int | width (bool constrained=false) const |
virtual D4Attributes * | attributes () |
virtual void | set_attributes (D4Attributes *) |
virtual void | set_attributes_nocopy (D4Attributes *) |
Static Public Member Functions | |
static AttrTable * | make_dropped_vars_attr_table (vector< BaseType *> *dropped_vars) |
Protected Types | |
typedef stack< SequenceValues * > | sequence_values_stack_t |
Protected Member Functions | |
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) |
void | m_duplicate (const Constructor &s) |
void | m_duplicate (const BaseType &bt) |
Perform a deep copy. More... | |
void | m_duplicate (const Sequence &s) |
BaseType * | m_exact_match (const string &name, btp_stack *s=0) |
BaseType * | m_leaf_match (const string &name, btp_stack *s=0) |
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 | |
bool | d_in_selection |
bool | d_is_synthesized |
std::vector< BaseType * > | d_vars |
Friends | |
class | SequenceTest |
Holds a sequence.
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 162 of file Sequence.h.
libdap::Sequence::Sequence | ( | const string & | n | ) |
The Sequence constructor.
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 161 of file Sequence.cc.
libdap::Sequence::Sequence | ( | const string & | n, |
const string & | d | ||
) |
The Sequence server-side constructor.
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 177 of file Sequence.cc.
libdap::Sequence::Sequence | ( | const Sequence & | rhs | ) |
The Sequence copy constructor.
Definition at line 185 of file Sequence.cc.
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 407 of file Constructor.cc.
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 from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 432 of file Constructor.cc.
|
virtualinherited |
DAP4 Attribute methods
Definition at line 599 of file BaseType.cc.
|
inlinevirtualinherited |
Reads the class data.
Reads the class data into the memory referenced by val. The caller should either allocate enough storage to val to hold the class data or set *val
to null. If *val is NULL, memory will be allocated by this function with new()
. 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.
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. |
Implements libdap::BaseType.
Definition at line 118 of file Constructor.h.
|
virtualinherited |
Compare an object's current state with the semantics of its type.
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 792 of file Constructor.cc.
|
virtual |
Remove any read or set data in the private data of the variable, setting read_p() to false. Used to clear any dynamically allocated storage that holds (potentially large) data. For the simple types, this no-op version is all that's needed. Vector and some other classes define a special version and have serialize() implementations that call it to free data as soon as possible after sending it.
Reimplemented from libdap::BaseType.
Definition at line 247 of file Sequence.cc.
|
virtualinherited |
include the data for this variable in the checksum DAP4 includes a checksum with every data response. This method adds the variable's data to that checksum.
checksum | A Crc32 instance that holds the current checksum. |
Implements libdap::BaseType.
Definition at line 550 of file Constructor.cc.
|
virtualinherited |
Evaluator a relop for DAP4.
This method is used by the filter expression evaluation code in DAP4. Each of the 'data type' classes that support relops must overload this method. In an expression of the form arg1 op arg2, this object is arg1, the parameter 'b' is arg2 and op is the relational operator.
b | The second argument in the relational expression |
op | The infix relational operator |
Reimplemented in libdap::Str, libdap::Int32, libdap::Float32, libdap::Byte, libdap::Float64, libdap::Int16, libdap::Int64, libdap::UInt64, and libdap::Int8.
Definition at line 1282 of file BaseType.cc.
|
virtualinherited |
Returns the name of the dataset used to create this instance.
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 358 of file BaseType.cc.
|
virtualinherited |
Remove an element from a Constructor.
n | name of the variable to remove |
Definition at line 448 of file Constructor.cc.
|
virtualinherited |
The DAP4 deserialization method.
um | |
dmr |
Error | or InternalErr |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::D4Sequence, and libdap::D4Group.
Definition at line 609 of file Constructor.cc.
|
virtual |
Deserialize (read from the network) the entire Sequence.
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 deserialize() 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. |
Reimplemented from libdap::Constructor.
Definition at line 1003 of file Sequence.cc.
|
virtual |
dumps information about this object
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 1278 of file Sequence.cc.
|
virtualinherited |
Count the members of constructor types.
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 194 of file Constructor.cc.
|
virtualinherited |
Return the FQN for this variable. This will include the D4 Group component of the name.
Reimplemented from libdap::BaseType.
Reimplemented in libdap::D4Group.
Definition at line 181 of file Constructor.cc.
|
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 582 of file BaseType.cc.
|
virtual |
Get the ending row number.
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 1093 of file Sequence.cc.
|
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 751 of file BaseType.cc.
|
virtual |
Get the row stride.
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 1077 of file Sequence.cc.
int libdap::Sequence::get_starting_row_number | ( | ) |
Get the 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 1062 of file Sequence.cc.
|
inline |
Get the unsent data property.
Definition at line 271 of file Sequence.h.
|
inherited |
Return the BaseType pointer for the ith variable.
i | This index |
Definition at line 397 of file Constructor.cc.
|
inherited |
Return the iterator for the ith variable.
i | the index |
Definition at line 388 of file Constructor.cc.
|
virtualinherited |
Read data into this variable.
eval | Evaluator for a constraint expression |
dmr | DMR for the whole dataset |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::D4Sequence, and libdap::D4Group.
Definition at line 556 of file Constructor.cc.
|
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 constraint evaluator |
dds | This DDS holds the variables for the data source |
Reimplemented from libdap::Constructor.
Definition at line 797 of file Sequence.cc.
|
virtualinherited |
|
virtual |
The Sequence class will be streamlined for DAP4.
Definition at line 272 of file Sequence.cc.
|
virtualinherited |
Is this variable part of the current selection?
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 703 of file BaseType.cc.
|
virtual |
Check to see whether this variable can be printed simply.
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 292 of file Sequence.cc.
|
virtualinherited |
Returns true if the instance is a numeric, string or URL type variable.
Definition at line 393 of file BaseType.cc.
|
virtualinherited |
Returns true if the instance is a vector (i.e., array) type variable.
Definition at line 402 of file BaseType.cc.
|
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 expression (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.
Reimplemented from libdap::BaseType.
Definition at line 413 of file Sequence.cc.
|
protectedinherited |
Perform a deep copy.
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 86 of file BaseType.cc.
|
virtualinherited |
Returns the name of the class instance.
Definition at line 320 of file BaseType.cc.
|
virtualinherited |
Evaluate relational operators.
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::D4Enum, libdap::Str, libdap::Int32, libdap::Float32, libdap::Byte, libdap::Float64, libdap::UInt32, libdap::D4Opaque, libdap::Int16, libdap::UInt16, libdap::Int64, libdap::UInt64, and libdap::Int8.
Definition at line 1256 of file BaseType.cc.
|
virtualinherited |
Write the DAP4 XML representation for this variable. This method is used to build the DAP4 DMR response object.
xml | An XMLWriter that will do the serialization |
constrained | True if the response should show the variables subject to the current constraint expression. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::D4Group.
Definition at line 768 of file Constructor.cc.
|
virtualinherited |
Print an ASCII representation of the variable structure.
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 626 of file Constructor.cc.
|
virtualinherited |
Print an ASCII representation of the variable structure.
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 617 of file Constructor.cc.
|
virtual |
Prints the value of the variable.
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. |
Reimplemented from libdap::Constructor.
Definition at line 1197 of file Sequence.cc.
|
virtual |
Prints the value of the variable.
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. |
Reimplemented from libdap::Constructor.
Definition at line 1192 of file Sequence.cc.
|
virtualinherited |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 695 of file Constructor.cc.
|
virtualinherited |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 684 of file Constructor.cc.
|
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.
Definition at line 718 of file Constructor.cc.
|
virtual |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
@note This method should \e not copy data values, but must copy all other fields in the object.
this
. Implements libdap::BaseType.
Definition at line 192 of file Sequence.cc.
|
virtualinherited |
simple implementation of read that iterates through vars and calls read on them
Reimplemented from libdap::BaseType.
Definition at line 476 of file Constructor.cc.
|
virtualinherited |
Has this variable been read?
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 480 of file BaseType.cc.
|
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 499 of file Sequence.cc.
void libdap::Sequence::reset_row_number | ( | ) |
Rest the row number counter.
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 427 of file Sequence.cc.
void libdap::Sequence::reset_row_number | ( | bool | recur | ) |
A recursive version of reset_row_number()
recur | If true, reset the row number of child sequences as well |
Definition at line 437 of file Sequence.cc.
|
virtual |
Get a whole row from the sequence.
row | Get row number row from the sequence. |
Definition at line 325 of file Sequence.cc.
|
virtualinherited |
Should this variable be sent?
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 554 of file BaseType.cc.
|
virtualinherited |
Serialize a Constructor.
m | |
dmr | Unused |
eval | Unused |
filter | Unused |
Error | is thrown if the value needs to be read and that operation fails. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::D4Sequence, and libdap::D4Group.
Definition at line 578 of file Constructor.cc.
|
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 case_1 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 case_2 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.
Reimplemented from libdap::Constructor.
Definition at line 607 of file Sequence.cc.
|
virtualinherited |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 590 of file BaseType.cc.
|
virtualinherited |
Set the in_selection property.
Set the in_selection property for this variable and all of its children.
state | Set the property value to state. |
Reimplemented from libdap::BaseType.
Definition at line 834 of file Constructor.cc.
|
virtual |
Mark the Sequence which holds the leaf elements.
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 effectively hidden from the serialization and evaluation code (see the documentation 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 1236 of file Sequence.cc.
|
inlinevirtualinherited |
Set the number of elements for this variable.
l | The number of elements |
Reimplemented in libdap::D4Sequence, and libdap::Vector.
Definition at line 214 of file BaseType.h.
|
virtualinherited |
Sets the name of the class instance.
Reimplemented in libdap::Vector.
Definition at line 344 of file BaseType.cc.
|
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 733 of file BaseType.cc.
|
virtualinherited |
Sets the value of the read_p property.
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 should 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::D4Group.
Definition at line 218 of file Constructor.cc.
|
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 ending row number. The 20th row is row 19. |
stride | The stride. A stride of two skips every other row. |
Definition at line 1106 of file Sequence.cc.
|
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::D4Group.
Definition at line 208 of file Constructor.cc.
|
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 463 of file BaseType.cc.
|
virtualinherited |
Sets the type of the class instance.
Definition at line 372 of file BaseType.cc.
|
inline |
Set the unsent data property.
Definition at line 277 of file Sequence.h.
|
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 337 of file Sequence.cc.
|
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 452 of file BaseType.cc.
|
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 277 of file Sequence.cc.
|
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 from libdap::BaseType.
Reimplemented in libdap::Grid.
Definition at line 844 of file Constructor.cc.
|
virtualinherited |
DAP4 to DAP2 transform.
For the current BaseType, return a DAP2 'copy' of the variable.
Additionally DAP4 adds the following types:
The | AttrTable pointer parent_attr_table is used by Groups, which disappear from the DAP2 representation. Their children are returned in the the BAseType vector their attributes are added to parent_attr_table; |
Reimplemented in libdap::Array, libdap::D4Enum, libdap::D4Group, libdap::D4Opaque, libdap::Byte, libdap::Structure, libdap::Int64, libdap::UInt64, and libdap::Int8.
Definition at line 259 of file BaseType.cc.
|
virtual |
Build a D4Sequence from a DAP2 Sequence.
Because DAP4 uses a different type for sequences, this code must be subclassed by anything other than trivial test code or client side-only uses of the library.
root | Use this as the environment for D4Dimensions |
container | Load the result into this container |
Reimplemented from libdap::Constructor.
Definition at line 212 of file Sequence.cc.
|
virtualinherited |
Returns the type of the class instance.
Definition at line 365 of file BaseType.cc.
|
virtualinherited |
Returns the type of the class instance as a string.
Definition at line 379 of file BaseType.cc.
|
inlinevirtualinherited |
Loads class data.
Store the value pointed to by val 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.
val | A pointer to the data to be inserted into the class data buffer. |
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. This is currently used only in the Vector class. |
Implements libdap::BaseType.
Definition at line 115 of file Constructor.h.
|
virtual |
Get the value for this sequence.
Definition at line 344 of file Sequence.cc.
|
virtual |
Get the value for this sequence.
Definition at line 352 of file Sequence.cc.
|
virtualinherited |
btp_stack no longer needed; use back pointers (BaseType::get_parent())
Reimplemented from libdap::BaseType.
Definition at line 267 of file Constructor.cc.
|
virtualinherited |
Reimplemented from libdap::BaseType.
Definition at line 279 of file Constructor.cc.
|
inherited |
Returns an iterator referencing the first structure element.
Definition at line 356 of file Constructor.cc.
|
inherited |
Returns an iterator referencing the end of the list of structure elements. Does not reference the last structure element.
Definition at line 364 of file Constructor.cc.
|
inherited |
Return a reverse iterator that references the last element.
Definition at line 371 of file Constructor.cc.
|
inherited |
Return a reverse iterator that references a point 'before' the first element.
Definition at line 379 of file Constructor.cc.
|
virtual |
Get the BaseType pointer to the named variable of a given row.
row | Read from row in the sequence. |
name | Return name from row. |
Definition at line 363 of file Sequence.cc.
|
virtual |
Get the BaseType pointer to the $i^{th}$ variable of row.
row | Read from row in the sequence. |
i | Return the $i^{th}$ variable from row. |
Definition at line 385 of file Sequence.cc.
|
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.
Definition at line 249 of file Constructor.cc.