libdap
Updated for version 3.20.6
libdap4 is an implementation of OPeNDAP's DAP protocol.
|
Holds a sequence. More...
#include <D4Sequence.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... | |
D4FilterClauseList & | clauses () |
Access the filter clauses for this D4Sequence. 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... | |
D4Sequence (const string &n) | |
The Sequence constructor. More... | |
D4Sequence (const string &n, const string &d) | |
The Sequence server-side constructor. More... | |
D4Sequence (const D4Sequence &rhs) | |
The Sequence copy constructor. 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 bool | deserialize (UnMarshaller &, DDS *, bool) |
Receive data from the net. More... | |
virtual void | deserialize (D4StreamUnMarshaller &um, DMR &dmr) |
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 BaseType * | get_parent () const |
BaseType * | get_var_index (int i) |
Vars_iter | get_vars_iter (int i) |
virtual void | intern_data (ConstraintEvaluator &, DDS &) |
virtual void | intern_data () |
Read data into this variable. More... | |
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_dap4 () const |
virtual bool | is_in_selection () |
Is this variable part of the current selection? More... | |
virtual bool | is_linear () |
Check to see whether this variable can be printed simply. More... | |
virtual bool | is_simple_type () 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 |
The number of elements in a Sequence object. More... | |
virtual string | name () const |
Returns the name of the class instance. More... | |
D4Sequence & | operator= (const D4Sequence &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_val (FILE *out, string space="", bool print_decl_p=true) |
Prints the value of the variable. More... | |
virtual void | print_val (ostream &out, string space="", bool print_decl_p=true) |
Prints the value of the variable. More... | |
virtual void | print_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 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_next_instance (bool filter) |
Read the next instance of the sequence While the rest of the variables' read() methods are assumed to return the entire variable in one call (modulo enhancements of the library to support streaming large variables), this class assumes that the underlying data store is returning data from a table of unknown size. Thus, D4Sequence::read() is assumed to return one instance (or element or row) of the sequence per call and return true when the EOF (end of the sequence) is reached. More... | |
virtual bool | read_p () |
Has this variable been read? More... | |
virtual D4SeqRow * | row_value (size_t row) |
Get a whole row from the sequence. More... | |
virtual bool | send_p () |
Should this variable be sent? More... | |
virtual bool | serialize (ConstraintEvaluator &, DDS &, Marshaller &, bool) |
Move data to the net, then remove them from the object. More... | |
virtual void | serialize (D4StreamMarshaller &m, DMR &dmr, bool filter=false) |
Serialize the values of a D4Sequence This method assumes that the underlying data store cannot/does not return a count of items separately from the items themselves. For a data store that does, this method should probably be specialized to take advantage of that. Because the DAP4 spec requires that a sequence be prefixed by a count, this method reads the entire sequence into memory before sending it (and counts the number of elements in the the process). For a data store where the count is available a priori, this could be rewritten so that the count is sent and then each instance/element of the sequence sent in succession. More... | |
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_length (int count) |
virtual void | set_name (const string &n) |
Sets the name of the class instance. More... | |
virtual void | set_parent (BaseType *parent) |
virtual void | set_read_p (bool state) |
Sets the value of the read_p property. More... | |
virtual void | set_send_p (bool state) |
virtual void | set_synthesized_p (bool state) |
virtual void | set_type (const Type &t) |
Sets the type of the class instance. More... | |
virtual void | set_value (D4SeqValues &values) |
Set the internal value. The 'values' of a D4Sequence is a vector of vectors of BaseType* objects. Using this method does not perform a deep copy; the BaseType*s are copied so the caller should not free them. Note that this does set d_length but the read_p flag for the BaseTypes should all be set to keep the serializer from trying to read each of them. More... | |
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 *dest) |
DAP2 to DAP4 transform. More... | |
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 D4SeqValues | value () const |
Get the values for this D4Sequence This method returns a reference to the values held by the instance. You should make sure that the instance really holds values before calling it! Do not free the BaseType*s contained in the vector of vectors. More... | |
virtual D4SeqValues & | value_ref () |
Get the sequence values by reference This method returns a reference to the D4Sequence's values, eliminating the copy of all the pointers. For large sequences, that could be a substantial number of values (even though they are 'just' pointers). More... | |
virtual BaseType * | var (const string &name, bool exact_match=true, btp_stack *s=0) |
btp_stack no longer needed; use back pointers (BaseType::get_parent()) More... | |
virtual BaseType * | var (const string &n, btp_stack &s) |
Vars_iter | var_begin () |
Vars_iter | var_end () |
Vars_riter | var_rbegin () |
Vars_riter | var_rend () |
virtual 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 Member Functions | |
void | m_duplicate (const Constructor &s) |
void | m_duplicate (const BaseType &bt) |
Perform a deep copy. More... | |
void | m_duplicate (const D4Sequence &s) |
BaseType * | m_exact_match (const string &name, btp_stack *s=0) |
BaseType * | m_leaf_match (const string &name, btp_stack *s=0) |
void | read_sequence_values (bool filter) |
Read a Sequence's value into memory. More... | |
Protected Attributes | |
bool | d_in_selection |
bool | d_is_synthesized |
int64_t | d_length |
D4SeqValues | d_values |
std::vector< BaseType * > | d_vars |
Friends | |
class | D4SequenceTest |
Holds a sequence.
This is the interface for the class D4Sequence. A sequence contains a single set of variables, all at the same lexical level just like a Structure. Like a Structure, a D4Sequence may contain other compound types, including other D4Sequences. Unlike a Structure, a D4Sequence defines a pattern that is repeated N times for a sequence of N elements. It is useful to think of a D4Sequence as representing a table of values (like a relational database), with each row of the table corresponding to a D4Sequence instance.'' (This usage can be confusing, since
instance'' also refers to a particular item of class D4Sequence.) For example:
D4Sequence { 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 D4Sequence can be arbitrarily long, which is to say that its length is not part of its declaration. A D4Sequence can contain other D4Sequences:
D4Sequence { String name; Int32 age; D4Sequence { String friend; } friend_list; } person;
Fred 34 Norman Andrea Ralph Lisa Ralph 23 Norman Andrea Lisa Marth Throckmorton Helga Millicent Andrea 29 Ralph Natasha Norman ... .. ...
Internally, the D4Sequence is represented by a vector of vectors. The members of the outer vector are the members of the D4Sequence. This includes the nested D4Sequences, as in the above example.
Because the length of a D4Sequence is indeterminate, there are changes to the behavior of the functions to read this class of data. The read()
function for D4Sequence must be written so that successive calls return values for successive rows of the D4Sequence.
Similar to a C structure, you refer to members of D4Sequence elements with a .'' notation. For example, if the D4Sequence has a member D4Sequence 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 133 of file D4Sequence.h.
libdap::D4Sequence::D4Sequence | ( | 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 136 of file D4Sequence.cc.
libdap::D4Sequence::D4Sequence | ( | 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 151 of file D4Sequence.cc.
libdap::D4Sequence::D4Sequence | ( | const D4Sequence & | rhs | ) |
The Sequence copy constructor.
Definition at line 157 of file D4Sequence.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.
D4FilterClauseList & libdap::D4Sequence::clauses | ( | ) |
Access the filter clauses for this D4Sequence.
When a filter is supplied with a DAP4 constraint, the expression is parsed and one or more D4FilterClause objects are built and stored in a D4FilterClauseList bound to the D4Sequence to be filtered.
Definition at line 417 of file D4Sequence.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 186 of file D4Sequence.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.
|
inlinevirtual |
Receive data from the net.
Receives data from the network connection identified by the source
parameter. The data is put into the class data buffer according to the input dds
.
This function is only used on the client side of the DODS client/server connection.
um | An UnMarshaller that knows how to deserialize data types |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. This would have been received from the server in an earlier transmission. |
reuse | A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is not reallocated. If FALSE, new storage is allocated. If the internal buffer has not been allocated at all, this argument has no effect. |
Error | when a problem reading from the UnMarshaller is found. |
Reimplemented from libdap::Constructor.
Definition at line 209 of file D4Sequence.h.
|
virtual |
The DAP4 deserialization method.
um | |
dmr |
Error | or InternalErr |
Reimplemented from libdap::Constructor.
Definition at line 391 of file D4Sequence.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 571 of file D4Sequence.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.
|
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.
|
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.
|
inlinevirtual |
Similar to using serialize() and deserialize() together in one object. Data are read as for serialize and those values are stored in the objects as deserialize() does but does not write and then read data to/from a stream.
This method is defined by the various data type classes. It calls the read() abstract method. Unlike serialize(), this method does not clear the memory use to hold the data values, so the caller should make sure to delete the DDS or the variable as soon as possible.
eval | Use this as the constraint expression evaluator. |
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. |
Reimplemented from libdap::Constructor.
Definition at line 203 of file D4Sequence.h.
|
virtual |
Read data into this variable.
eval | Evaluator for a constraint expression |
dmr | DMR for the whole dataset |
Reimplemented from libdap::Constructor.
Definition at line 260 of file D4Sequence.cc.
|
virtualinherited |
|
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.
|
virtualinherited |
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 in libdap::Sequence, and libdap::Structure.
Definition at line 823 of file Constructor.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.
|
inlinevirtual |
The number of elements in a Sequence object.
Reimplemented from libdap::BaseType.
Definition at line 193 of file D4Sequence.h.
|
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.
|
virtualinherited |
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::BaseType.
Reimplemented in libdap::Sequence, and libdap::Grid.
Definition at line 650 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 556 of file D4Sequence.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 163 of file D4Sequence.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.
|
virtual |
Read the next instance of the sequence While the rest of the variables' read() methods are assumed to return the entire variable in one call (modulo enhancements of the library to support streaming large variables), this class assumes that the underlying data store is returning data from a table of unknown size. Thus, D4Sequence::read() is assumed to return one instance (or element or row) of the sequence per call and return true when the EOF (end of the sequence) is reached.
For each call to read, the values for each of the sequence's members are expected to have been loaded into the member's BaseType variables; this method will copy them out and store then in the D4Sequence's internal storage. This method always returns the next instance that satisfies the CE when 'filter' is true.
dmr | |
eval | |
filter |
Definition at line 231 of file D4Sequence.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.
|
protected |
Read a Sequence's value into memory.
This is a helper method for serialize() that enables the code to recursively read values for child sequences. This method assumes that the D4Sequence::read() method does not call itself recursively for child sequences, as is the case with DAP2 sequences. If you have a data store that requires the outer-most sequence to read values for its child sequences, you will need to specialize this method. See also the methods associated with the sequence values because unlike DAP2 sequences, in DAP4 the sequences hold all their values in memory before writing them out.
filter | True if the/a file expression bound to this sequence should be evaluated. |
Definition at line 306 of file D4Sequence.cc.
|
virtual |
Get a whole row from the sequence.
row | Get row number row from the sequence. |
Definition at line 449 of file D4Sequence.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.
|
inlinevirtual |
Move data to the net, then remove them from the object.
Sends the data from the indicated (local) dataset through the connection identified by the Marshaller parameter. If the data is not already incorporated into the DDS object, read the data from the dataset. Once the data are sent (written to the Marshaller), they are deleted from the object and the object state is reset so that they will be read again if the read() method is called.
This function is only used on the server side of the client/server connection, and is generally only called from the ResponseBuilder functions. It has no BaseType implementation; each datatype child class supplies its own implementation.
@param eval Use this as the constraint expression evaluator.
dds | The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure. |
m | A marshaller used to serialize data types |
ce_eval | A boolean value indicating whether to evaluate the DODS constraint expression that may accompany this dataset. The constraint expression is stored in the dds. |
InternalErr. | |
Error. |
Reimplemented from libdap::Constructor.
Definition at line 206 of file D4Sequence.h.
|
virtual |
Serialize the values of a D4Sequence This method assumes that the underlying data store cannot/does not return a count of items separately from the items themselves. For a data store that does, this method should probably be specialized to take advantage of that. Because the DAP4 spec requires that a sequence be prefixed by a count, this method reads the entire sequence into memory before sending it (and counts the number of elements in the the process). For a data store where the count is available a priori, this could be rewritten so that the count is sent and then each instance/element of the sequence sent in succession.
If this method is specialized, once the data are loaded into the D4SeqValues instance, make sure to set d_length and make sure to set_read_p for each BaseType in D4SeqValues.
m | Stream data sink |
dmr | DMR object for the evaluator |
eval | CE Evaluator object |
filter | True if the CE should be evaluated, false otherwise. |
Reimplemented from libdap::Constructor.
Definition at line 369 of file D4Sequence.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.
|
inlinevirtual |
Set the length of the sequence.
count |
Reimplemented from libdap::BaseType.
Definition at line 199 of file D4Sequence.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.
|
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.
|
inlinevirtual |
Set the internal value. The 'values' of a D4Sequence is a vector of vectors of BaseType* objects. Using this method does not perform a deep copy; the BaseType*s are copied so the caller should not free them. Note that this does set d_length but the read_p flag for the BaseTypes should all be set to keep the serializer from trying to read each of them.
values |
Definition at line 271 of file D4Sequence.h.
|
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.
|
virtualinherited |
Write out the object's internal fields in a string. To be used for debugging when regular inspection w/ddd or gdb isn't enough.
Reimplemented in libdap::Sequence.
Definition at line 184 of file BaseType.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.
|
virtualinherited |
DAP2 to DAP4 transform.
For the current BaseType, return a DAP4 'copy' of the variable.
root | The root group that should hold this new variable. Add Group-level stuff here (e.g., D4Dimensions). |
container | Add the new variable to this container. |
Reimplemented from libdap::BaseType.
Reimplemented in libdap::Sequence, libdap::Grid, and libdap::Structure.
Definition at line 141 of file Constructor.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.
|
inlinevirtual |
Get the values for this D4Sequence This method returns a reference to the values held by the instance. You should make sure that the instance really holds values before calling it! Do not free the BaseType*s contained in the vector of vectors.
Definition at line 281 of file D4Sequence.h.
|
inlinevirtual |
Get the sequence values by reference This method returns a reference to the D4Sequence's values, eliminating the copy of all the pointers. For large sequences, that could be a substantial number of values (even though they are 'just' pointers).
Definition at line 291 of file D4Sequence.h.
|
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 466 of file D4Sequence.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 481 of file D4Sequence.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.