libdap++  Updated for version 3.11.7
libdap::Sequence Class Reference

Holds a sequence. More...

#include <Sequence.h>

Inheritance diagram for libdap::Sequence:
Inheritance graph
Collaboration diagram for libdap::Sequence:
Collaboration graph

Public Types

typedef stack< BaseType * > btp_stack
 
typedef std::vector< BaseType * >
::const_iterator 
Vars_citer
 
typedef std::vector< BaseType * >
::iterator 
Vars_iter
 
typedef std::vector< BaseType * >
::reverse_iterator 
Vars_riter
 

Public Member Functions

virtual void add_var (BaseType *, Part part=nil)
 Adds a variable to the Sequence. More...
 
virtual void add_var_nocopy (BaseType *, Part part=nil)
 Adds a variable to the Sequence. More...
 
virtual unsigned int buf2val (void **val)
 
virtual bool check_semantics (string &msg, bool all=false)
 Compare an object's current state with the semantics of its type. More...
 
string dataset () const
 Returns the name of the dataset used to create this instance. More...
 
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 AttrTableget_attr_table ()
 
virtual int get_ending_row_number ()
 Get the ending row number. More...
 
virtual BaseTypeget_parent ()
 
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 ()
 Get the unsent data property. More...
 
BaseTypeget_var_index (int i)
 
Vars_iter get_vars_iter (int i)
 
virtual void intern_data (ConstraintEvaluator &eval, DDS &dds)
 
virtual bool is_constructor_type ()
 Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. More...
 
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 ()
 Returns true if the instance is a numeric, string or URL type variable. More...
 
virtual bool is_vector_type ()
 Returns true if the instance is a vector (i.e., array) type variable. More...
 
virtual int length ()
 
string name () const
 Returns the name of the class instance. More...
 
virtual int number_of_rows ()
 
Sequenceoperator= (const Sequence &rhs)
 
virtual bool ops (BaseType *b, int op)
 Evaluate relational operators. More...
 
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_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 BaseTypeptr_duplicate ()
 
virtual bool read ()
 Read data into a local buffer. 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...
 
virtual BaseTypeRowrow_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 bool serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
 
virtual void set_attr_table (const AttrTable &at)
 
virtual void set_in_selection (bool state)
 
virtual void set_leaf_p (bool state)
 
virtual void set_leaf_sequence (int lvl=1)
 Mark the Sequence which holds the leaf elements. 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)
 
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_container)
 
Type type () const
 Returns the type of the class instance. More...
 
string type_name () const
 Returns the type of the class instance as a string. More...
 
virtual unsigned int val2buf (void *val, bool reuse=false)
 
virtual SequenceValues value ()
 
virtual BaseTypevar (const string &name, bool exact_match=true, btp_stack *s=0)
 Returns a pointer to a member of a constructor class. More...
 
virtual BaseTypevar (const string &n, btp_stack &s)
 
Vars_iter var_begin ()
 
Vars_iter var_end ()
 
Vars_riter var_rbegin ()
 
Vars_riter var_rend ()
 
virtual BaseTypevar_value (size_t row, const string &name)
 Get the BaseType pointer to the named variable of a given row. More...
 
virtual BaseTypevar_value (size_t row, size_t i)
 Get the BaseType pointer to the $i^{th}$ variable of row. More...
 
virtual unsigned int width ()
 Returns the size of the class instance data. More...
 
virtual unsigned int width (bool constrained)
 
virtual ~Sequence ()
 

Protected Types

typedef stack< SequenceValues * > sequence_values_stack_t
 

Protected Member Functions

void _duplicate (const Constructor &s)
 
void _duplicate (const BaseType &bt)
 Perform a deep copy. More...
 
virtual void intern_data_for_leaf (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack)
 
virtual void intern_data_parent_part_one (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack)
 
virtual void intern_data_parent_part_two (DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack)
 
virtual void intern_data_private (ConstraintEvaluator &eval, DDS &dds, sequence_values_stack_t &sequence_values_stack)
 
virtual bool serialize_leaf (DDS &dds, ConstraintEvaluator &eval, Marshaller &m, bool ce_eval)
 
virtual bool serialize_parent_part_one (DDS &dds, ConstraintEvaluator &eval, Marshaller &m)
 
virtual void serialize_parent_part_two (DDS &dds, ConstraintEvaluator &eval, Marshaller &m)
 

Protected Attributes

std::vector< BaseType * > _vars
 

Friends

class SequenceTest
 

Detailed Description

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, sinceinstance'' 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 calledTom'' and Tom has a member Float32 called shoe_size'', you can refer to Tom's shoe size as Tom.shoe_size''.

Note
This class contains the 'logic' for both the server- and client-side behavior. The field d_values is used by the client-side methods to store the entire Sequence. On the server-side, the read() method uses an underlying data system to read one row of data values which are then serialized using the serialize() methods of each variable.
Todo:
Refactor along with Structure moving methods up into Constructor.
Todo:
Add an isEmpty() method which returns true if the Sequence is empty. This should work before and after calling deserialize().

Definition at line 173 of file Sequence.h.

Member Typedef Documentation

typedef stack<BaseType *> libdap::BaseType::btp_stack
inherited

Definition at line 218 of file BaseType.h.

Definition at line 219 of file Sequence.h.

typedef std::vector<BaseType *>::const_iterator libdap::Constructor::Vars_citer
inherited

Definition at line 60 of file Constructor.h.

typedef std::vector<BaseType *>::iterator libdap::Constructor::Vars_iter
inherited

Definition at line 61 of file Constructor.h.

typedef std::vector<BaseType *>::reverse_iterator libdap::Constructor::Vars_riter
inherited

Definition at line 62 of file Constructor.h.

Constructor & Destructor Documentation

libdap::Sequence::Sequence ( const string &  n)

The Sequence constructor requires only the name of the variable to be created. The name may be omitted, which will create a nameless variable. This may be adequate for some applications.

Parameters
nA string containing the name of the variable to be created.

Definition at line 162 of file Sequence.cc.

Referenced by buf2val(), ptr_duplicate(), and val2buf().

libdap::Sequence::Sequence ( const string &  n,
const string &  d 
)

The Sequence server-side constructor requires the name of the variable to be created and the dataset name from which this variable is being created.

Parameters
nA string containing the name of the variable to be created.
dA string containing the name of the dataset from which this variable is being created.

Definition at line 179 of file Sequence.cc.

libdap::Sequence::Sequence ( const Sequence rhs)

Definition at line 188 of file Sequence.cc.

libdap::Sequence::~Sequence ( )
virtual

Definition at line 216 of file Sequence.cc.

References libdap::Constructor::_vars, and DBG2.

Member Function Documentation

void libdap::Constructor::_duplicate ( const Constructor s)
protectedinherited

Definition at line 57 of file Constructor.cc.

Referenced by libdap::Constructor::operator=().

void libdap::BaseType::_duplicate ( const BaseType bt)
protectedinherited

Perform a deep copy. Copies the values of bt into *this. Pointers are dereferenced and their values are copied into a newly allocated instance.

Parameters
btThe source object.

Definition at line 80 of file BaseType.cc.

References DBG2.

Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().

void libdap::Sequence::add_var ( BaseType bt,
Part  part = nil 
)
virtual

Remember that if you wish to add a member to a nested Sequence, you must use the add_var() of that Sequence. This means that variable names need not be unique among a set of nested Sequences.

Parameters
btA pointer to the DAP2 type variable to add to this Sequence.
partdefaults to nil

Reimplemented from libdap::BaseType.

Definition at line 340 of file Sequence.cc.

References libdap::Constructor::_vars, libdap::BaseType::ptr_duplicate(), and libdap::BaseType::set_parent().

Here is the call graph for this function:

void libdap::Sequence::add_var_nocopy ( BaseType bt,
Part  part = nil 
)
virtual
Note
Remember that if you wish to add a member to a nested Sequence, you must use the add_var() of that Sequence. This means that variable names need not be unique among a set of nested Sequences.
This method does not copy the BaseType object; the caller must not free the pointer.
Parameters
btA pointer to the DAP2 type variable to add to this Sequence.
partdefaults to nil

Definition at line 365 of file Sequence.cc.

References libdap::Constructor::_vars, and libdap::BaseType::set_parent().

Here is the call graph for this function:

unsigned int libdap::Sequence::buf2val ( void **  val)
virtual

Never use this interface for Sequence! Use Sequence::var_value() or Sequence::row_value().

Deprecated:

Implements libdap::BaseType.

Definition at line 1331 of file Sequence.cc.

References Sequence().

Here is the call graph for this function:

bool libdap::Sequence::check_semantics ( string &  msg,
bool  all = false 
)
virtual

This function checks the class instance for internal consistency. This is important to check for complex constructor classes. For BaseType, an object is semantically correct if it has both a non-null name and type.

For example, an Int32 instance would return FALSE if it had no name or no type defined. A Grid instance might return FALSE for more complex reasons, such as having Map arrays of the wrong size or shape.

This function is used by the DDS class, and will rarely, if ever, be explicitly called by a DODS application program. A variable must pass this test before it is sent, but there may be many other stages in a retrieve operation where it would fail.

Returns
Returns FALSE when the current state violates some aspect of the type semantics, TRUE otherwise.
Parameters
msgA returned string, containing a message indicating the source of any problem.
allFor complex constructor types (Grid, Sequence, Structure), this flag indicates whether to check the semantics of the member variables, too.
See also
DDS::check_semantics

Reimplemented from libdap::BaseType.

Definition at line 1491 of file Sequence.cc.

References libdap::Constructor::_vars, libdap::BaseType::check_semantics(), libdap::BaseType::name(), libdap::BaseType::type_name(), and libdap::unique_names().

Here is the call graph for this function:

string libdap::BaseType::dataset ( ) const
inherited

A dataset from which the data is to be read. The meaning of this string will vary among different types of data sources. It may be the name of a data file or an identifier used to read data from a relational database.

Definition at line 231 of file BaseType.cc.

Referenced by read_row(), libdap::Str::serialize(), libdap::Int16::serialize(), libdap::UInt16::serialize(), libdap::Float32::serialize(), libdap::UInt32::serialize(), libdap::Int32::serialize(), libdap::Float64::serialize(), libdap::Byte::serialize(), libdap::Vector::serialize(), libdap::Structure::serialize(), and libdap::Grid::serialize().

bool libdap::Sequence::deserialize ( UnMarshaller um,
DDS dds,
bool  reuse = false 
)
virtual

This method used to read a single row at a time. Now the entire sequence is read at once. The method used to return True to indicate that more data needed to be deserialized and False when the sequence was completely read. Now it simply returns false. This might seem odd, but making this method return false breaks existing software the least.

Parameters
umAn UnMarshaller that knows how to deserialize data
ddsA DataDDS from which to read.
reusePassed to child objects when they are deserialized. Some implementations of derialize() use this to determine if new storage should be allocated or existing storage reused.
Exceptions
Errorif a sequence stream marker cannot be read.
InternalErrif the dds param is not a DataDDS.
Returns
A return value of false indicates that an EOS ("end of Sequence") marker was found, while a value of true indicates that there are more rows to be read. This version always reads the entire sequence, so it always returns false.

Implements libdap::BaseType.

Definition at line 1201 of file Sequence.cc.

References libdap::Constructor::_vars, DBG2, libdap::BaseType::deserialize(), libdap::DataDDS::get_protocol(), libdap::DataDDS::get_protocol_major(), libdap::DataDDS::get_protocol_minor(), libdap::BaseType::name(), libdap::BaseType::print_val(), and libdap::BaseType::ptr_duplicate().

Here is the call graph for this function:

void libdap::Sequence::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance and information about this instance.

Parameters
strmC++ i/o stream to dump the information to
Returns
void

Reimplemented from libdap::Constructor.

Definition at line 1589 of file Sequence.cc.

References libdap::Constructor::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().

Here is the call graph for this function:

int libdap::Sequence::element_count ( bool  leaves = false)
virtual

Return a count of the total number of variables in this variable. This is used to count the number of variables held by a constructor variable - for simple type and vector variables it always returns 1.

For compound data types, there are two ways to count members. You can count the members, or you can count the simple members and add that to the count of the compound members. For example, if a Structure contains an Int32 and another Structure that itself contains two Int32 members, the element count of the top-level structure could be two (one Int32 and one Structure) or three (one Int32 by itself and two Int32's in the subsidiary Structure). Use the leaves parameter to control which kind of counting you desire.

Returns
Returns 1 for simple types. For compound members, the count depends on the leaves argument.
Parameters
leavesThis parameter is only relevant if the object contains other compound data types. If FALSE, the function counts only the data variables mentioned in the object's declaration. If TRUE, it counts the simple members, and adds that to the sum of the counts for the compound members. This parameter has no effect for simple type variables.

Reimplemented from libdap::BaseType.

Definition at line 258 of file Sequence.cc.

References libdap::Constructor::_vars.

Referenced by print_one_row().

AttrTable & libdap::BaseType::get_attr_table ( )
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 531 of file BaseType.cc.

Referenced by libdap::Constructor::print_xml(), libdap::Grid::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::BaseType::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::Constructor::transfer_attributes(), libdap::Grid::transfer_attributes(), and libdap::BaseType::transfer_attributes().

int libdap::Sequence::get_ending_row_number ( )
virtual

Return the ending row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.

If the bracket notation was not used to constrain this sequence, this method returns -1.

Returns
The ending row number.

Definition at line 1293 of file Sequence.cc.

Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().

BaseType * libdap::BaseType::get_parent ( )
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.

Returns
A BaseType pointer to the variable's parent.

Definition at line 653 of file BaseType.cc.

Referenced by libdap::function_linear_scale(), intern_data_for_leaf(), intern_data_parent_part_two(), serialize_leaf(), and serialize_parent_part_two().

int libdap::Sequence::get_row_stride ( )
virtual

Return the row stride number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row stride is applied to the sequence after applying the relational constraint.

If the bracket notation was not used to constrain this sequence, this method returns -1.

Returns
The row stride.

Definition at line 1276 of file Sequence.cc.

Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().

int libdap::Sequence::get_starting_row_number ( )

Return the starting row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.

If the bracket notation was not used to constrain this sequence, this method returns -1.

Returns
The starting row number.

Definition at line 1260 of file Sequence.cc.

Referenced by intern_data_for_leaf(), and intern_data_parent_part_one().

bool libdap::Sequence::get_unsent_data ( )
inline

Definition at line 296 of file Sequence.h.

Referenced by intern_data_parent_part_two().

BaseType * libdap::Constructor::get_var_index ( int  i)
inherited

Return the BaseType pointer for the ith variable.

Parameters
iThis index
Returns
The corresponding BaseType*.

Definition at line 336 of file Constructor.cc.

References libdap::Constructor::_vars.

Constructor::Vars_iter libdap::Constructor::get_vars_iter ( int  i)
inherited

Return the iterator for the ith variable.

Parameters
ithe index
Returns
The corresponding Vars_iter

Definition at line 327 of file Constructor.cc.

References libdap::Constructor::_vars.

void libdap::Sequence::intern_data ( ConstraintEvaluator eval,
DDS dds 
)
virtual

This method is used to evaluate a constraint and based on those results load the Sequence variable with data. This simulates having a server call the serialize() method and a client call the deserialize() method without the overhead of any IPC. Use this method on the server-side to 'load the d_values field with data' so that other code and work with those data.

The somewhat odd algorithm used by serialize() is largely copied here, so comments about logic in serialize() and the related methods apply here as well.

Note
Even though each Sequence variable has a values field, only the top-most Sequence in a hierarchy of Sequences holds values. The field accessed by the var_value() method is completely linked object; access the values of nested Sequences using the BaseType objects returned by var_value().
Only call this method for top-most Sequences. Never call it for Sequences which have a parent (directly or indirectly) variable that is a Sequence.
Parameters
evalUse this contraint evaluator
ddsThis DDS holds the variables for the data source

Reimplemented from libdap::BaseType.

Definition at line 974 of file Sequence.cc.

References DBG, DBG2, intern_data_private(), and libdap::BaseType::name().

Here is the call graph for this function:

void libdap::Sequence::intern_data_for_leaf ( DDS dds,
ConstraintEvaluator eval,
sequence_values_stack_t sequence_values_stack 
)
protectedvirtual
void libdap::Sequence::intern_data_parent_part_one ( DDS dds,
ConstraintEvaluator eval,
sequence_values_stack_t sequence_values_stack 
)
protectedvirtual
void libdap::Sequence::intern_data_parent_part_two ( DDS dds,
ConstraintEvaluator eval,
sequence_values_stack_t sequence_values_stack 
)
protectedvirtual
void libdap::Sequence::intern_data_private ( ConstraintEvaluator eval,
DDS dds,
sequence_values_stack_t sequence_values_stack 
)
protectedvirtual

Definition at line 992 of file Sequence.cc.

References DBG, intern_data_for_leaf(), intern_data_parent_part_one(), is_leaf_sequence(), and libdap::BaseType::name().

Referenced by intern_data(), and intern_data_parent_part_one().

Here is the call graph for this function:

bool libdap::BaseType::is_in_selection ( )
virtualinherited

Does this variable appear in either the selection part or as a function argument in the current constrain expression. If this property is set (true) then implementations of the read() method should read this variable.

Note
This method does not check, nor does it know about the semantics of, string arguments passed to functions. Those functions might include variable names in strings; they are responsible for reading those variables. See the grid (func_grid_select()) for an example.
See also
BaseType::read()

Definition at line 605 of file BaseType.cc.

bool libdap::Sequence::is_leaf_sequence ( )
virtual

Definition at line 1516 of file Sequence.cc.

Referenced by intern_data_private(), serialize(), and set_leaf_sequence().

bool libdap::Sequence::is_linear ( )
virtual

True if the instance can be flattened and printed as a single table of values. For Arrays and Grids this is always false. For Structures and Sequences the conditions are more complex. The implementation provided by this class always returns false. Other classes should override this implementation.

Todo:
Change the name to is_flattenable or something like that. 05/16/03 jhrg
Returns
True if the instance can be printed as a single table of values, false otherwise.

Reimplemented from libdap::Constructor.

Definition at line 272 of file Sequence.cc.

References libdap::Constructor::_vars, libdap::dods_sequence_c, and libdap::dods_structure_c.

bool libdap::BaseType::is_simple_type ( )
virtualinherited
int libdap::Sequence::length ( )
virtual

Returns the number of elements in a Sequence object. Note that this is not the number of items in a row, but the number of rows in the complete sequence object. To be meaningful, this must be computed after constraint expresseion (CE) evaluation. The purpose of this function is to facilitate translations between Sequence objects and Array objects, particularly when the Sequence is too large to be transferred from the server to the client in its entirety.

This function, to be useful, must be specialized for the API and data format in use.

Returns
The base implentation returns -1, indicating that the length is not known. Sub-classes specific to a particular API will have a more complete implementation.

Definition at line 578 of file Sequence.cc.

string libdap::BaseType::name ( ) const
inherited

Definition at line 210 of file BaseType.cc.

Referenced by libdap::Structure::_duplicate(), libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Structure::check_semantics(), libdap::Grid::check_semantics(), check_semantics(), deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), libdap::GSEClause::get_map_name(), libdap::GridGeoConstraint::GridGeoConstraint(), libdap::GSEClause::GSEClause(), libdap::Vector::intern_data(), libdap::Structure::intern_data(), intern_data(), libdap::BaseType::intern_data(), intern_data_for_leaf(), intern_data_parent_part_one(), intern_data_parent_part_two(), intern_data_private(), libdap::DDS::leaf_match(), libdap::DDS::mark(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::Constructor::print_xml(), libdap::Grid::print_xml(), libdap::Array::print_xml_core(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::BaseType::read(), read_row(), libdap::DODSFilter::send_data_ddx(), libdap::Str::serialize(), serialize(), serialize_leaf(), serialize_parent_part_one(), serialize_parent_part_two(), set_leaf_sequence(), libdap::BaseType::set_name(), libdap::BaseType::set_read_p(), libdap::BaseType::set_send_p(), libdap::Constructor::transfer_attributes(), libdap::Grid::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::rvalue::value_name(), libdap::Structure::var(), libdap::Grid::var(), libdap::Vector::var(), var(), and var_value().

int libdap::Sequence::number_of_rows ( )
virtual

Definition at line 585 of file Sequence.cc.

Referenced by print_val_by_rows().

Sequence & libdap::Sequence::operator= ( const Sequence rhs)

Definition at line 229 of file Sequence.cc.

bool libdap::BaseType::ops ( BaseType b,
int  op 
)
virtualinherited

This method contains the relational operators used by the constraint expression evaluator in the DDS class. Each class that wants to be able to evaluate relational expressions must overload this function. The implementation in BaseType throws an InternalErr exception. The DAP library classes Byte, ..., Url provide specializations of this method. It is not meaningful for classes such as Array because relational expressions using Array are not supported.

The op argument refers to a table generated by bison from the constraint expression parser. Use statements like the following to correctly interpret its value:

switch (op) {
    case EQUAL: return i1 == i2;
    case NOT_EQUAL: return i1 != i2;
    case GREATER: return i1 > i2;
    case GREATER_EQL: return i1 >= i2;
    case LESS: return i1 < i2;
    case LESS_EQL: return i1 <= i2;
    case REGEXP: throw Error("Regular expressions are not supported for integer values");
    default: throw Error("Unknown operator");
}

This function is used by the constraint expression evaluator.

Parameters
bCompare the value of this instance with b.
opAn integer index indicating which relational operator is implied. Choose one from the following: EQUAL, NOT_EQUAL, GREATER, GREATER_EQL, LESS, LESS_EQL, and REGEXP.
Returns
The boolean value of the comparison.

Reimplemented in libdap::Byte, libdap::Float64, libdap::Int32, libdap::UInt32, libdap::Float32, libdap::Int16, libdap::UInt16, and libdap::Str.

Definition at line 1108 of file BaseType.cc.

Referenced by libdap::Clause::value().

void libdap::Constructor::print_decl ( ostream &  out,
string  space = "    ",
bool  print_semi = true,
bool  constraint_info = false,
bool  constrained = false 
)
virtualinherited

Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.

A simple array declaration might look like this:

Float64 lat[lat = 180];

While a more complex declaration (for a Grid, in this case), would look like this:

Grid {
ARRAY:
Int32 sst[time = 404][lat = 180][lon = 360];
MAPS:
Float64 time[time = 404];
Float64 lat[lat = 180];
Float64 lon[lon = 360];
} sst;
Parameters
outThe output stream on which to print the declaration.
spaceEach line of the declaration will begin with the characters in this string. Usually used for leading spaces.
print_semiA boolean value indicating whether to print a semicolon at the end of the declaration.
constraint_infoA 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.
constrainedIf 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.
See also
DDS
DDS::CE

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 369 of file Constructor.cc.

References libdap::Constructor::_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().

Referenced by libdap::Structure::print_val(), and print_val_by_rows().

Here is the call graph for this function:

void libdap::Constructor::print_decl ( FILE *  out,
string  space = "    ",
bool  print_semi = true,
bool  constraint_info = false,
bool  constrained = false 
)
virtualinherited

Write the variable's declaration in a C-style syntax. This function is used to create textual representation of the Data Descriptor Structure (DDS). See The DODS User Manual for information about this structure.

A simple array declaration might look like this:

Float64 lat[lat = 180];

While a more complex declaration (for a Grid, in this case), would look like this:

Grid {
ARRAY:
Int32 sst[time = 404][lat = 180][lon = 360];
MAPS:
Float64 time[time = 404];
Float64 lat[lat = 180];
Float64 lon[lon = 360];
} sst;
Parameters
outThe output stream on which to print the declaration.
spaceEach line of the declaration will begin with the characters in this string. Usually used for leading spaces.
print_semiA boolean value indicating whether to print a semicolon at the end of the declaration.
constraint_infoA 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.
constrainedIf 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.
See also
DDS
DDS::CE

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 343 of file Constructor.cc.

References libdap::Constructor::_vars, libdap::id2www(), libdap::BaseType::name(), libdap::BaseType::send_p(), and libdap::BaseType::type_name().

Here is the call graph for this function:

void libdap::Sequence::print_one_row ( ostream &  out,
int  row,
string  space,
bool  print_row_num = false 
)
virtual

Definition at line 1378 of file Sequence.cc.

References libdap::dods_sequence_c, element_count(), libdap::BaseType::print_val(), libdap::BaseType::type(), and var_value().

Referenced by print_val_by_rows().

Here is the call graph for this function:

void libdap::Sequence::print_one_row ( FILE *  out,
int  row,
string  space,
bool  print_row_num = false 
)
virtual

Definition at line 1339 of file Sequence.cc.

References libdap::dods_sequence_c, element_count(), libdap::BaseType::print_val(), libdap::BaseType::type(), and var_value().

Here is the call graph for this function:

void libdap::Sequence::print_val ( ostream &  out,
string  space = "",
bool  print_decl_p = true 
)
virtual

Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.

Parameters
outThe output ostream on which to print the value.
spaceThis value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_pA boolean value controlling whether the variable declaration is printed as well as the value.

Implements libdap::BaseType.

Definition at line 1484 of file Sequence.cc.

References print_val_by_rows().

Here is the call graph for this function:

void libdap::Sequence::print_val ( FILE *  out,
string  space = "",
bool  print_decl_p = true 
)
virtual

Prints the value of the variable, with its declaration. This function is primarily intended for debugging DODS applications. However, it can be overloaded and used to do some useful things. Take a look at the asciival and writeval clients, both of which overload this to output the values of variables in different ways.

Parameters
outThe output stream on which to print the value.
spaceThis value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_pA boolean value controlling whether the variable declaration is printed as well as the value.

Implements libdap::BaseType.

Definition at line 1477 of file Sequence.cc.

References print_val_by_rows().

Here is the call graph for this function:

void libdap::Sequence::print_val_by_rows ( ostream &  out,
string  space = "",
bool  print_decl_p = true,
bool  print_row_numbers = true 
)
virtual

Definition at line 1451 of file Sequence.cc.

References number_of_rows(), libdap::Constructor::print_decl(), and print_one_row().

Referenced by print_val().

Here is the call graph for this function:

void libdap::Sequence::print_val_by_rows ( FILE *  out,
string  space = "",
bool  print_decl_p = true,
bool  print_row_numbers = true 
)
virtual

Definition at line 1425 of file Sequence.cc.

References number_of_rows(), libdap::Constructor::print_decl(), and print_one_row().

Here is the call graph for this function:

void libdap::Constructor::print_xml ( ostream &  out,
string  space = "    ",
bool  constrained = false 
)
virtualinherited
void libdap::Constructor::print_xml ( FILE *  out,
string  space = "    ",
bool  constrained = false 
)
virtualinherited
void libdap::Constructor::print_xml_writer ( XMLWriter xml,
bool  constrained = false 
)
virtualinherited

Write the XML representation of this variable. This method is used to build the DDX XML response.

Parameters
outDestination output stream
spaceUse this to indent child declarations. Default is "".
constrainedIf 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 505 of file Constructor.cc.

References libdap::BaseType::get_attr_table(), XMLWriter::get_writer(), libdap::BaseType::name(), libdap::AttrTable::print_xml_writer(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().

Here is the call graph for this function:

BaseType * libdap::Sequence::ptr_duplicate ( )
virtual

Clone this instance. Allocate a new instance and copy *this into it. This method must perform a deep copy.

Note
This method should not copy data values, but must copy all other fields in the object.
Returns
A newly allocated copy of this.

Implements libdap::BaseType.

Definition at line 194 of file Sequence.cc.

References Sequence().

Here is the call graph for this function:

bool libdap::BaseType::read ( )
virtualinherited

This method should be implemented for each of the data type classes (Byte, ..., Grid) when using the DAP class library to build a server. This method is only for DAP servers. The library provides a default definition here which throws an InternalErr exception unless the read_p property has been set. In that case it returns false, indicating that all the data have been read. The latter case can happen when building a constant value that needs to be passed to a function. The variable/constant is loaded with a value when it is created.

When implementing a new DAP server, the Byte, ..., Grid data type classes are usually specialized. In each of those specializations read() should be defined to read values from the data source and store them in the object's local buffer. The read() method is called by other methods in this library. When writing read(), follow these rules:

  • read() should throw Error if it encounters an error. The message should be verbose enough to be understood by someone running a client on a different machine.
  • The value(s) should be read if and only if either send_p() or is_in_selection() return true. If neither of these return true, the value(s) should not be read. This is important when writing read() for a Constructor type such as Grid where a client may ask for only the map vectors (and thus reading the much larger Array part is not needed).
  • For each specialization of read(), the method should first test the value of the read_p property (using the read_p() method) and read values only if the value of read_p() is false. Once the read() method reads data and stores it in the instance, it must set the value of the read_p property to true using set_read_p(). If your read() methods fail to do this data may not serialize correctly.
  • The Array::read() and Grid::read() methods should take into account any restrictions on Array sizes.
  • If you are writing Sequence::read(), be sure to check the documentation for Sequence::read_row() and Sequence::serialize() so you understand how Sequence::read() is being called.
  • For Sequence::read(), your specialization must correctly manage the unsent_data property and row count in addition to the read_p property (handle the read_p property as describe above). For a Sequence to serialize correctly, once all data from the Sequence has been read, unsent_data property must be set to false (use Sequence::set_unsent_data()). Also, at that time the row number counter must be reset (use Sequence::reset_row_counter()). Typically the correct time to set unsent_data to false and reset the row counter is the time when Sequence::read() return false indicating that all the data for the Sequence have been read. Failure to handle these tasks will break serialization of nested Sequences. Note that when Sequence::read() returns with a result of true (indicating there is more data to send, the value of the unsent_data property should be true.

    Also, if you server must handle nested sequences, be sure to read about subclassing set_read_p().

Returns
The return value of this method for all types except Sequence should always be false. Sequences should return true to indicate more values remain in the Sequence, false to indicate no more values remain. (see Sequence::serialize() and Sequence::read_row()).
See also
BaseType
Sequence

Reimplemented in libdap::Structure.

Definition at line 788 of file BaseType.cc.

References libdap::BaseType::name().

Referenced by libdap::GridGeoConstraint::apply_constraint_to_data(), libdap::ArrayGeoConstraint::apply_constraint_to_data(), libdap::GeoConstraint::flip_latitude_within_array(), libdap::function_geogrid(), libdap::function_grid(), libdap::function_linear_scale(), libdap::function_miic_ex2(), libdap::Vector::intern_data(), libdap::Grid::intern_data(), libdap::BaseType::intern_data(), libdap::Str::ops(), libdap::Int16::ops(), libdap::UInt16::ops(), libdap::Float32::ops(), libdap::UInt32::ops(), libdap::Float64::ops(), libdap::Int32::ops(), libdap::Byte::ops(), read_row(), libdap::GeoConstraint::reorder_data_longitude_axis(), libdap::Str::serialize(), libdap::Int16::serialize(), libdap::UInt16::serialize(), libdap::Float32::serialize(), libdap::UInt32::serialize(), libdap::Int32::serialize(), libdap::Float64::serialize(), libdap::Byte::serialize(), libdap::Vector::serialize(), and libdap::Grid::serialize().

Here is the call graph for this function:

bool libdap::BaseType::read_p ( )
virtualinherited
bool libdap::Sequence::read_row ( int  row,
DDS dds,
ConstraintEvaluator eval,
bool  ce_eval = true 
)
virtual

Read row number row of the Sequence. The values of the row are obtained by calling the read() method of the sequence. The current row just read is stored in the Sequence instance along with its row number. If a selection expression has been supplied, rows are counted only if they satisfy that expression.

Note that we can only advance in a Sequence. It is not possible to back up and read a row numbered lower than the current row. If you need that you will need to replace the serialize() method with one of your own.

Used on the server side.

Note
The first row is row number zero. A Sequence with 100 rows will have row numbers 0 to 99.
Todo:
This code ignores the main reason for nesting the sequences, that if the outer Sequence's current instance fails the CE, there's no need to look at the values of the inner Sequence. But in the code that calls this method (serialize() and intern_data()) the CE is not evaluated until the inner-most Sequence (i.e., the leaf Sequence) is read. That means that each instance of the inner Sequence is read and the CE evaluated for each of those reads. To fix this, and the overall problem of complexity here, we need to re-think Sequences and how they behave. 11/13/2007 jhrg
Returns
A boolean value, with TRUE indicating that read_row should be called again because there's more data to be read. FALSE indicates the end of the Sequence.
Parameters
rowThe row number to read.
ddsA reference to the DDS for this dataset.
evalUse this as the constraint expression evaluator.
ce_evalIf True, evaluate any CE, otherwise do not.

Definition at line 652 of file Sequence.cc.

References libdap::BaseType::dataset(), DBG2, libdap::ConstraintEvaluator::eval_selection(), libdap::BaseType::name(), libdap::BaseType::read(), libdap::BaseType::read_p(), set_read_p(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().

Referenced by intern_data_for_leaf(), intern_data_parent_part_one(), serialize_leaf(), and serialize_parent_part_one().

Here is the call graph for this function:

void libdap::Sequence::reset_row_number ( )

When reading a nested sequence, use this method to reset the internal row number counter. This is necessary so that the second, ... instances of the inner/nested sequence will start off reading row zero.

Definition at line 594 of file Sequence.cc.

Referenced by intern_data_parent_part_one().

BaseTypeRow * libdap::Sequence::row_value ( size_t  row)
virtual
Parameters
rowGet row number row from the sequence.
Returns
A BaseTypeRow object (vector<BaseType *>). Null if there's no such row number as row.

Definition at line 454 of file Sequence.cc.

Referenced by var_value().

bool libdap::BaseType::send_p ( )
virtualinherited

Returns the state of the send_p property. If true, this variable should be sent to the client, if false, it should not. If no constraint expression (CE) has been evaluated, this property is true for all variables in a data source (i.e., for all the variables listed in a DDS). If a CE has been evaluated, this property is true only for those variables listed in the projection part of the CE.

Returns
True if the variable should be sent to the client, false otherwise.

Definition at line 503 of file BaseType.cc.

Referenced by libdap::Grid::components(), libdap::ConstraintEvaluator::eval_function_clauses(), libdap::function_linear_scale(), libdap::Grid::intern_data(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::Array::print_decl(), libdap::BaseType::print_decl(), libdap::Grid::print_val(), libdap::Constructor::print_xml(), libdap::Grid::print_xml(), libdap::BaseType::print_xml(), libdap::Array::print_xml_core(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::BaseType::print_xml_writer(), libdap::Array::print_xml_writer_core(), libdap::Grid::projection_yields_grid(), libdap::Grid::serialize(), and libdap::Grid::width().

bool libdap::Sequence::serialize ( ConstraintEvaluator eval,
DDS dds,
Marshaller m,
bool  ce_eval = true 
)
virtual

Serialize a Sequence.

Leaf Sequences must be marked as such (see DDS::tag_nested_sequence()), as must the top most Sequence.

How the code works. Methods called for various functions are named in brackets:

  1. Sending a one-level sequence:

    Dataset {
        Sequence {
            Int x;
            Int y;
        } flat;
    } case_1;
    

    Serialize it by reading successive rows and sending all of those that satisfy the CE. Before each row, send a start of instance (SOI) marker. Once all rows have been sent, send an End of Sequence (EOS) marker.[serialize_leaf].

  2. Sending a nested sequence:

    Dataset {
        Sequence {
            Int t;
            Sequence {
                Int z;
            } inner;
        } outer;
    } case_2;
    

    Serialize by reading the first row of outer and storing the values. Do not evaluate the CE [serialize_parent_part_one]. Call serialize() for inner and read each row for it, evaluating the CE for each row that is read. After the first row of inner is read and satisfies the CE, write out the SOI marker and values for outer [serialize_parent_part_two], then write the SOI and values for the first row of inner. Continue to read and send rows of inner until the last row has been read. Send EOS for inner [serialize_leaf]. Now read the next row of outer and repeat. Once outer is completely read, send its EOS marker.

Notes:

  1. 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.

  2. CE evaluation happens only in a leaf sequence.

  3. When no data statisfies a CE, the empty Sequence is signalled by a single EOS marker, regardless of the level of nesting of Sequences. That is, the EOS marker is sent for only the outer Sequence in the case of a completely empty response.

Implements libdap::BaseType.

Definition at line 772 of file Sequence.cc.

References DBG2, is_leaf_sequence(), libdap::BaseType::name(), serialize_leaf(), and serialize_parent_part_one().

Here is the call graph for this function:

bool libdap::Sequence::serialize_leaf ( DDS dds,
ConstraintEvaluator eval,
Marshaller m,
bool  ce_eval 
)
protectedvirtual

Definition at line 887 of file Sequence.cc.

References libdap::Constructor::_vars, DBG, libdap::dods_sequence_c, libdap::BaseType::get_parent(), libdap::BaseType::name(), read_row(), set_read_p(), and libdap::BaseType::type().

Referenced by serialize().

Here is the call graph for this function:

bool libdap::Sequence::serialize_parent_part_one ( DDS dds,
ConstraintEvaluator eval,
Marshaller m 
)
protectedvirtual

Definition at line 789 of file Sequence.cc.

References libdap::Constructor::_vars, DBG, DBG2, libdap::dods_sequence_c, libdap::BaseType::name(), read_row(), and set_read_p().

Referenced by serialize().

Here is the call graph for this function:

void libdap::Sequence::serialize_parent_part_two ( DDS dds,
ConstraintEvaluator eval,
Marshaller m 
)
protectedvirtual

Definition at line 855 of file Sequence.cc.

References libdap::Constructor::_vars, DBG, libdap::dods_sequence_c, libdap::BaseType::get_parent(), libdap::BaseType::name(), and libdap::BaseType::type().

Here is the call graph for this function:

void libdap::BaseType::set_attr_table ( const AttrTable at)
virtualinherited

Set this variable's attribute table.

Parameters
atSource of the attributes.

Definition at line 539 of file BaseType.cc.

void libdap::Sequence::set_in_selection ( bool  state)
virtual

Set the in_selection property to state. This property indicates that the variable is used as a parameter to a constraint expression function or that it appears as an argument in a selection sub-expression. If set (true), implementations of the BaseType::read() method should read this variable.

Parameters
stateSet the in_selection property to this state.
See also
BaseType::read()
BaseType::is_in_selection() for more information.

Reimplemented from libdap::BaseType.

Definition at line 321 of file Sequence.cc.

References libdap::Constructor::_vars, and libdap::BaseType::set_in_selection().

Here is the call graph for this function:

void libdap::Sequence::set_leaf_p ( bool  state)
virtual

Definition at line 1510 of file Sequence.cc.

Referenced by set_leaf_sequence().

void libdap::Sequence::set_leaf_sequence ( int  lvl = 1)
virtual

In a nested Sequence, the Sequence which holds the leaf elements is special because it during the serialization of this Sequence's data that constraint Expressions must be evaluated. If CEs are evaluated at the upper levels, then valid data may not be sent because it was effectlively hidden from the serialization and evaluation code (see the documentatin for the serialize_leaf() method).

The notion of the leaf Sequence needs to be modified to mean the lowest level of a Sequence where data are to be sent. Suppose there's a two level Sequence, but that only fields from the top level are to be sent. Then that top level is also the leaf Sequence and should be marked as such. If the lower level is marked as a leaf Sequence, then no values will ever be sent since the send_p property will always be false for each field and it's the call to serialize_leaf() that actually triggers transmission of values (because it's not until the code makes it into serialize_leaf() that it knows there are values to be sent.

Note
This method must not be called before the CE is parsed.
Parameters
lvlThe current level of the Sequence. a lvl of 1 indicates the topmost Sequence. The default value is 1.
See also
Sequence::serialize_leaf()

Definition at line 1546 of file Sequence.cc.

References libdap::Constructor::_vars, DBG2, libdap::dods_sequence_c, libdap::dods_structure_c, is_leaf_sequence(), libdap::BaseType::name(), set_leaf_p(), libdap::Structure::set_leaf_sequence(), and set_leaf_sequence().

Referenced by set_leaf_sequence().

Here is the call graph for this function:

void libdap::BaseType::set_name ( const string &  n)
virtualinherited
void libdap::BaseType::set_parent ( BaseType parent)
virtualinherited

Set the parent property for this variable.

Note
Added ability to set parent to null. 10/19/12 jhrg
Parameters
parentPointer 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).
Exceptions
InternalErrthrown if called with anything other than a Constructor, Vector or Null.

Definition at line 635 of file BaseType.cc.

Referenced by libdap::Vector::_duplicate(), libdap::Structure::_duplicate(), libdap::Grid::_duplicate(), libdap::Grid::add_map(), libdap::Structure::add_var(), libdap::Grid::add_var(), libdap::Vector::add_var(), add_var(), libdap::Structure::add_var_nocopy(), libdap::Grid::add_var_nocopy(), libdap::Vector::add_var_nocopy(), add_var_nocopy(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().

void libdap::Sequence::set_read_p ( bool  state)
virtual

Sets the value of the read_p property. This indicates that the value(s) of this variable has/have been read. An implementation of the read() method would typically use this to set the read_p property to true.

Note
For most of the types the default implementation of this method is fine. However, if you're building a server which must handle data represented using nested sequences, then you may need to provide a specialization of Sequence::set_read_p(). By default Sequence::set_read_() recursively sets the read_p property for all child variables to state. For servers where one Sequence reads an outer set of values and another reads an inner set, this is cumbersome. In such a case, it is easier to specialize Sequence::set_read_p() so that it does not recursively set the read_p property for the inner Sequence. Be sure to see the documentation for the read() method!
For synthesized variables, this method does nothing. Thus, if a synthesized variable is added to a Sequence, the Sequence can iteratively reset the read_p property without affecting the value of that property for the synthesized variable. That's important since a synthesized variable's value is calculated, not read.
Todo:
Look at making synthesized variables easier to implement and at making them more integrated into the overall CE evaluation process. Maybe the code that computes the synthesized var's value should be in the that variable's read() method? This might provide a way to get rid of the awkward 'projection functions' by replacing them with real children of BaseType. It would also provide a way to clean up the way the synthesized_p prop intrudes on the read_p prop.
See also
BaseType::read()
Parameters
stateSet the read_p property to this state.

Reimplemented from libdap::BaseType.

Definition at line 311 of file Sequence.cc.

References libdap::Constructor::_vars, and libdap::BaseType::set_read_p().

Referenced by intern_data_for_leaf(), intern_data_parent_part_one(), read_row(), serialize_leaf(), and serialize_parent_part_one().

Here is the call graph for this function:

void libdap::Sequence::set_row_number_constraint ( int  start,
int  stop,
int  stride = 1 
)
virtual

Set the start, stop and stride for a row-number type constraint. This should be used only when the sequence is constrained using the bracket notation (which supplies start, stride and stop information). If omitted, the stride defaults to 1.

Parameters
startThe starting row number. The first row is row zero.
stopThe eding row number. The 20th row is row 19.
strideThe stride. A stride of two skips every other row.

Definition at line 1307 of file Sequence.cc.

References malformed_expr.

void libdap::Sequence::set_send_p ( bool  state)
virtual

Sets the value of the send_p flag. This function is meant to be called from within the constraint evaluator of other code which determines that this variable should be returned to the client. Data are ready to be sent when both the _send_p and _read_p flags are set to TRUE.

Parameters
stateThe logical state to set the send_p flag.

Reimplemented from libdap::BaseType.

Definition at line 301 of file Sequence.cc.

References libdap::Constructor::_vars, and libdap::BaseType::set_send_p().

Here is the call graph for this function:

void libdap::BaseType::set_synthesized_p ( bool  state)
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!

See also
synthesized_p()

Definition at line 427 of file BaseType.cc.

void libdap::BaseType::set_type ( const Type t)
inherited

Definition at line 245 of file BaseType.cc.

Referenced by libdap::Url::Url().

void libdap::Sequence::set_unsent_data ( bool  usd)
inline

Definition at line 302 of file Sequence.h.

Referenced by intern_data_parent_part_two().

void libdap::Sequence::set_value ( SequenceValues values)
virtual

Set value of this Sequence. This does not perform a deep copy, so data should be allocated on the heap and freed only when the Sequence dtor is called.

See also
SequenceValues
BaseTypeRow
Parameters
valuesSet the value of this Sequence.

Definition at line 468 of file Sequence.cc.

bool libdap::BaseType::synthesized_p ( )
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 416 of file BaseType.cc.

string libdap::Sequence::toString ( )
virtual

Write out the object's internal fields in a string. To be used for debugging when regular inspection w/ddd or gdb isn't enough.

Returns
A string which shows the object's internal stuff.

Reimplemented from libdap::BaseType.

Definition at line 242 of file Sequence.cc.

References libdap::Constructor::_vars, and libdap::BaseType::toString().

Here is the call graph for this function:

void libdap::Constructor::transfer_attributes ( AttrTable at_container)
virtualinherited

Given an Attribute table, scavenge attributes from it and load them into this object and the variables it contains.

This implementation differs from the version in BaseType in that each of the children of the Constructor are passed an attribute container if one is found that matches the name of this Constructor variable.

Parameters
at_containerSearch for attributes in this container.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 264 of file Constructor.cc.

References libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::AttrTable::attr_begin(), libdap::Attr_container, libdap::AttrTable::attr_end(), DBG, libdap::BaseType::get_attr_table(), libdap::AttrTable::get_attr_table(), libdap::AttrTable::get_attr_type(), libdap::AttrTable::get_attr_vector(), libdap::Error::get_error_message(), libdap::AttrTable::get_name(), libdap::AttrTable::get_type(), libdap::AttrTable::is_global_attribute(), libdap::BaseType::name(), libdap::AttrTable::set_is_global_attribute(), libdap::BaseType::var(), libdap::Constructor::var_begin(), and libdap::Constructor::var_end().

Here is the call graph for this function:

unsigned int libdap::Sequence::val2buf ( void *  val,
bool  reuse = false 
)
virtual

Never use this interface for Sequence! To add data to the members of a Sequence, use BaseTypeRow variables and operate on them individually.

Implements libdap::BaseType.

Definition at line 1320 of file Sequence.cc.

References Sequence().

Here is the call graph for this function:

SequenceValues libdap::Sequence::value ( )
virtual

Get the value for this sequence.

Returns
The SequenceValues object for this Sequence.

Definition at line 476 of file Sequence.cc.

BaseType * libdap::Sequence::var ( const string &  name,
bool  exact_match = true,
btp_stack s = 0 
)
virtual

Returns a pointer to the contained variable in a composite class. The composite classes are those made up of aggregated simple data types. Array, Grid, and Structure are composite types, while Int and Float are simple types. This function is only used by composite classes. The BaseType implementation always returns null.

Several of the subclasses provide alternate access methods that make sense for that particular data type. For example, the Array class defines a *var(int i) method that returns the ith entry in the Array data, and the Structure provides a *var(Vars_iter) function using a pseudo-index to access the different members of the structure.

Parameters
nameThe name of the class member. Defaults to ""
exact_matchTrue if only interested in variables whose full names match n exactly. If false, returns the first variable whose name matches name. For example, if name is x and point.x is a variable, then var("x", false) would return a BaseType pointer to point.x. If exact_match was true then name would need to be "point.x" for var to return that pointer. This feature simplifies constraint expressions for datasets which have complex, nested, constructor variables. Defaults to true.
sRecord the path to name. Defaults to null, in which case it is not used.
Returns
A pointer to the member named in the n argument. If no name is given, the function returns the first (only) variable. For example, an Array has only one variable, while a Structure can have many.

Reimplemented from libdap::BaseType.

Definition at line 388 of file Sequence.cc.

References libdap::www2id().

Here is the call graph for this function:

BaseType * libdap::Sequence::var ( const string &  name,
btp_stack s 
)
virtual

This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as BaseType::var(const string &, bool, btp_stack *) when exact_match is false. In addition to returning a pointer to the variable, it pushes onto s a BaseType pointer to each constructor type that ultimately contains name.

Note
The BaseType implementation always returns null. There are no default values for the parameters. If var() is called w/o any params, the three parameter version will be used.
Deprecated:
This method is deprecated because it tries first to use exact_match and, if that fails, then tries leaf_match. It's better to use the alternate form of var(...) and specify exactly what you'd like to do.
Returns
A pointer to the named variable.

Reimplemented from libdap::BaseType.

Definition at line 376 of file Sequence.cc.

References libdap::BaseType::name(), and libdap::www2id().

Here is the call graph for this function:

Constructor::Vars_iter libdap::Constructor::var_end ( )
inherited
Constructor::Vars_riter libdap::Constructor::var_rbegin ( )
inherited

Return a reverse iterator that references the last element.

Definition at line 310 of file Constructor.cc.

References libdap::Constructor::_vars.

Constructor::Vars_riter libdap::Constructor::var_rend ( )
inherited

Return a reverse iterator that references a point 'before' the first element.

Definition at line 318 of file Constructor.cc.

References libdap::Constructor::_vars.

BaseType * libdap::Sequence::var_value ( size_t  row,
const string &  name 
)
virtual
Parameters
rowRead from row in the sequence.
nameReturn name from row.
Returns
A BaseType which holds the variable and its value.
See also
number_of_rows

Definition at line 487 of file Sequence.cc.

References libdap::BaseType::name(), and row_value().

Referenced by print_one_row().

Here is the call graph for this function:

BaseType * libdap::Sequence::var_value ( size_t  row,
size_t  i 
)
virtual
Parameters
rowRead from row in the sequence.
iReturn the $i^{th}$ variable from row.
Returns
A BaseType which holds the variable and its value.
See also
number_of_rows

Definition at line 510 of file Sequence.cc.

References row_value().

Here is the call graph for this function:

unsigned int libdap::Sequence::width ( )
virtual

Return the number of bytes that are required to hold the instance's value. In the case of simple types such as Int32, this is the size of one Int32 (four bytes). For a String or Url type, width() returns the number of bytes needed for a String * variable, not the bytes needed for all the characters, since that value cannot be determined from type information alone. For Structure, and other constructor types size() returns the number of bytes needed to store pointers to the C++ objects.

Implements libdap::BaseType.

Definition at line 523 of file Sequence.cc.

References libdap::Constructor::_vars.

unsigned int libdap::Sequence::width ( bool  constrained)
virtual

This version of width simply returns the same thing as width() for simple types and Arrays. For Sequence it returns the total row size if constrained is false, or the size of the row elements in the current projection if true.

Parameters
constrainedIf true, return the size after applying a constraint.
Returns
The number of bytes used by the variable.

Reimplemented from libdap::BaseType.

Definition at line 542 of file Sequence.cc.

References libdap::Constructor::_vars.

Friends And Related Function Documentation

friend class SequenceTest
friend

Definition at line 215 of file Sequence.h.

Member Data Documentation


The documentation for this class was generated from the following files: