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

Holds a structure (aggregate) type. More...

#include <Structure.h>

Inheritance diagram for libdap::Structure:
Inheritance graph
Collaboration diagram for libdap::Structure:
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 *bt, Part part=nil)
 
virtual void add_var_nocopy (BaseType *bt, Part part=nil)
 
virtual unsigned int buf2val (void **val)
 Never call this. More...
 
virtual bool check_semantics (string &msg, bool all=false)
 Compare an object's current state with the semantics of its type. More...
 
string dataset () const
 Returns the name of the dataset used to create this instance. More...
 
virtual void del_var (const string &name)
 
virtual bool deserialize (UnMarshaller &um, DDS *dds, bool reuse=false)
 Receive data from the net. More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual int element_count (bool leaves=false)
 Count the members of constructor types. More...
 
virtual AttrTableget_attr_table ()
 
virtual BaseTypeget_parent ()
 
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_linear ()
 Check to see whether this variable can be printed simply. More...
 
virtual bool is_simple_type ()
 Returns true if the instance is a numeric, string or URL type variable. More...
 
virtual bool is_vector_type ()
 Returns true if the instance is a vector (i.e., array) type variable. More...
 
string name () const
 Returns the name of the class instance. More...
 
Structureoperator= (const Structure &rhs)
 
virtual bool ops (BaseType *b, int op)
 Evaluate relational operators. More...
 
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_val (FILE *out, string space="", bool print_decl_p=true)
 Prints the value of the variable. More...
 
virtual void print_val (ostream &out, string space="", bool print_decl_p=true)
 Prints the value of the variable. More...
 
virtual void print_xml (ostream &out, string space=" ", bool constrained=false)
 
virtual void print_xml (FILE *out, string space=" ", bool constrained=false)
 
virtual void print_xml_writer (XMLWriter &xml, bool constrained=false)
 
virtual BaseTypeptr_duplicate ()
 
virtual bool read ()
 simple implementation of reat that iterates through vars and calls read on them More...
 
virtual bool read_p ()
 Has this variable been read? More...
 
virtual bool send_p ()
 Should this variable be sent? More...
 
virtual bool serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
 Move data to the net. More...
 
virtual void set_attr_table (const AttrTable &at)
 
virtual void set_in_selection (bool state)
 Set the in_selection property. More...
 
virtual void set_leaf_sequence (int level=1)
 Traverse Structure, set Sequence leaf nodes. More...
 
virtual void set_name (const string &n)
 Sets the name of the class instance. More...
 
virtual void set_parent (BaseType *parent)
 
virtual void set_read_p (bool state)
 Sets the value of the read_p property. More...
 
virtual void set_send_p (bool state)
 
virtual void set_synthesized_p (bool state)
 
void set_type (const Type &t)
 Sets the type of the class instance. More...
 
 Structure (const string &n)
 
 Structure (const string &n, const string &d)
 
 Structure (const Structure &rhs)
 
virtual bool synthesized_p ()
 
virtual string toString ()
 
virtual void transfer_attributes (AttrTable *at_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)
 Never call this. More...
 
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 unsigned int width ()
 Returns the size of the class instance data. More...
 
virtual unsigned int width (bool constrained)
 
virtual ~Structure ()
 

Protected Member Functions

void _duplicate (const Constructor &s)
 
void _duplicate (const Structure &s)
 
void _duplicate (const BaseType &bt)
 Perform a deep copy. More...
 

Protected Attributes

std::vector< BaseType * > _vars
 

Detailed Description

This data type is used to hold a collection of related data types, in a manner roughly corresponding to a C structure. The member types can be simple or compound types, and can include other Structures.

The DAP2 structure is defined as a singly-linked list. This means that Structure elements can be accessed either by name, with the var() function, or by their position in the list, either with the overloaded version of var(), or the combination of the first_var() and next_var() functions.

The val2buf() and buf2val() functions only return the size of the structure. To read parts of a DAP2 Structure into an application program, use the buf2val() function of the element of the Structure in question.

Note that the predicate-setting functions set_send_p() and set_read_p() set their flags for the Structure as well as for each of the Structure's member elements.

Similar to C, you can refer to members of Structure elements with a .'' notation. For example, if the Structure has a member Structure calledTom'' and Tom has a member Float32 called shoe_size'', then you can refer to Tom's shoe size as Tom.shoe_size''.

Todo:
Refactor with Sequence moving methods up into Constructor.

Definition at line 100 of file Structure.h.

Member Typedef Documentation

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

Definition at line 218 of file BaseType.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::Structure::Structure ( const string &  n)

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

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

Definition at line 92 of file Structure.cc.

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

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

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

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 104 of file Structure.cc.

libdap::Structure::Structure ( const Structure rhs)

The Structure copy constructor.

Definition at line 109 of file Structure.cc.

References _duplicate().

Here is the call graph for this function:

libdap::Structure::~Structure ( )
virtual

Definition at line 114 of file Structure.cc.

References libdap::Constructor::_vars.

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::Structure::_duplicate ( const Structure s)
protected

Definition at line 66 of file Structure.cc.

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

Referenced by operator=(), and Structure().

Here is the call graph for this function:

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::Structure::add_var ( BaseType bt,
Part  part = nil 
)
virtual

Adds an element to a Structure.

Parameters
btA pointer to the DAP2 type variable to add to this Structure.
partNot used by this class, defaults to nil

Reimplemented from libdap::BaseType.

Definition at line 221 of file Structure.cc.

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

Referenced by libdap::DDS::add_var(), and libdap::function_miic_ex2().

Here is the call graph for this function:

void libdap::Structure::add_var_nocopy ( BaseType bt,
Part  part = nil 
)
virtual

Adds an element to a Structure.

Parameters
btA pointer to the DAP2 type variable to add to this Structure.
partNot used by this class, defaults to nil

Definition at line 244 of file Structure.cc.

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

Referenced by libdap::DDS::add_var_nocopy().

Here is the call graph for this function:

unsigned int libdap::Structure::buf2val ( void **  val)
virtual
See also
val2buf()
Returns
Returns the size of the structure.

Implements libdap::BaseType.

Definition at line 410 of file Structure.cc.

References Structure().

Here is the call graph for this function:

bool libdap::Structure::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 549 of file Structure.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 libdap::Sequence::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(), serialize(), and libdap::Grid::serialize().

void libdap::Structure::del_var ( const string &  n)
virtual

Removed an element from a Structure.

Parameters
nname of the variable to remove

Definition at line 261 of file Structure.cc.

References libdap::Constructor::_vars.

Referenced by libdap::DDS::del_var().

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

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.

Parameters
umAn UnMarshaller that knows how to deserialize data types
ddsThe 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.
reuseA 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.
Returns
Always returns TRUE.
Exceptions
Errorwhen a problem reading from the UnMarshaller is found.
See also
DDS

Implements libdap::BaseType.

Definition at line 382 of file Structure.cc.

References libdap::Constructor::_vars.

void libdap::Structure::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 582 of file Structure.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::Structure::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 142 of file Structure.cc.

References libdap::Constructor::_vars.

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().

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(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_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::Structure::intern_data ( ConstraintEvaluator eval,
DDS dds 
)
virtual

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.

Parameters
evalUse this as the constraint expression evaluator.
ddsThe Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure.

Reimplemented from libdap::BaseType.

Definition at line 332 of file Structure.cc.

References libdap::Constructor::_vars, DBG, libdap::BaseType::name(), read(), and libdap::BaseType::read_p().

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::Structure::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 156 of file Structure.cc.

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

bool libdap::BaseType::is_simple_type ( )
virtualinherited
string libdap::BaseType::name ( ) const
inherited

Definition at line 210 of file BaseType.cc.

Referenced by _duplicate(), libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), check_semantics(), libdap::Grid::check_semantics(), libdap::Sequence::check_semantics(), libdap::Sequence::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(), intern_data(), libdap::Sequence::intern_data(), libdap::BaseType::intern_data(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::intern_data_private(), libdap::DDS::leaf_match(), libdap::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(), libdap::Sequence::read_row(), libdap::DODSFilter::send_data_ddx(), libdap::Str::serialize(), libdap::Sequence::serialize(), libdap::Sequence::serialize_leaf(), libdap::Sequence::serialize_parent_part_one(), libdap::Sequence::serialize_parent_part_two(), libdap::Sequence::set_leaf_sequence(), libdap::BaseType::set_name(), libdap::BaseType::set_read_p(), libdap::BaseType::set_send_p(), libdap::Constructor::transfer_attributes(), libdap::Grid::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::rvalue::value_name(), var(), libdap::Grid::var(), libdap::Vector::var(), libdap::Sequence::var(), and libdap::Sequence::var_value().

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

Definition at line 129 of file Structure.cc.

References _duplicate().

Here is the call graph for this function:

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 print_val(), and libdap::Sequence::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::Structure::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 508 of file Structure.cc.

References libdap::Constructor::_vars, and libdap::Constructor::print_decl().

Here is the call graph for this function:

void libdap::Structure::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 529 of file Structure.cc.

References libdap::Constructor::_vars, and libdap::Constructor::print_decl().

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::Structure::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 123 of file Structure.cc.

References Structure().

Here is the call graph for this function:

bool libdap::Structure::read ( )
virtual
Returns
returns false to signify all has been read

Reimplemented from libdap::BaseType.

Definition at line 279 of file Structure.cc.

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

Referenced by intern_data(), and serialize().

Here is the call graph for this function:

bool libdap::BaseType::read_p ( )
virtualinherited
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::Structure::serialize ( ConstraintEvaluator eval,
DDS dds,
Marshaller m,
bool  ce_eval = true 
)
virtual

Sends the data from the indicated (local) dataset through the connection identified by the sink parameter. If the data is not already incorporated into the DDS object, read the data from the dataset.

This function is only used on the server side of the client/server connection, and is generally only called from the ResponseBuilder functions. It has no BaseType implementation; each datatype child class supplies its own implementation.

Parameters
evalUse this as the constraint expression evaluator.
ddsThe Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure.
mA marshaller used to serialize data types
ce_evalA boolean value indicating whether to evaluate the DODS constraint expression that may accompany this dataset. The constraint expression is stored in dds.
Returns
This method always returns true. Older versions used the return value to signal success or failure.
Exceptions
InternalErr.
Error.
See also
DDS

Implements libdap::BaseType.

Definition at line 346 of file Structure.cc.

References libdap::Constructor::_vars, libdap::BaseType::dataset(), libdap::dods_grid_c, libdap::dods_structure_c, libdap::ConstraintEvaluator::eval_selection(), libdap::XDRStreamMarshaller::get_checksum(), read(), libdap::BaseType::read_p(), libdap::XDRStreamMarshaller::reset_checksum(), libdap::DDS::timeout_off(), and libdap::DDS::timeout_on().

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::Structure::set_in_selection ( bool  state)
virtual

Set the in_selection property for this variable and all of its children.

Parameters
stateSet the property value to state.

Reimplemented from libdap::BaseType.

Definition at line 195 of file Structure.cc.

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

Here is the call graph for this function:

void libdap::Structure::set_leaf_sequence ( int  level = 1)
virtual

Definition at line 206 of file Structure.cc.

References libdap::dods_sequence_c, libdap::dods_structure_c, libdap::Constructor::var_begin(), and libdap::Constructor::var_end().

Referenced by libdap::Sequence::set_leaf_sequence().

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(), _duplicate(), libdap::Grid::_duplicate(), libdap::Grid::add_map(), add_var(), libdap::Grid::add_var(), libdap::Vector::add_var(), libdap::Sequence::add_var(), add_var_nocopy(), libdap::Grid::add_var_nocopy(), libdap::Vector::add_var_nocopy(), libdap::Sequence::add_var_nocopy(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().

void libdap::Structure::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 180 of file Structure.cc.

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

Referenced by read().

Here is the call graph for this function:

void libdap::Structure::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 170 of file Structure.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().

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::BaseType::toString ( )
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.

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

Reimplemented in libdap::Sequence.

Definition at line 161 of file BaseType.cc.

References libdap::BaseType::type_name().

Referenced by libdap::GSEClause::GSEClause(), and libdap::Sequence::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::Structure::val2buf ( void *  val,
bool  reuse = false 
)
virtual

This method cannot be used to change values of a Structure since the values of a Constructor type must be set using methods in Constructor. See the Constructor::var_begin() and related methods.

Todo:
Make this throw an exception
Returns
Returns the size of the structure.

Implements libdap::BaseType.

Definition at line 401 of file Structure.cc.

References Structure().

Here is the call graph for this function:

BaseType * libdap::Structure::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 416 of file Structure.cc.

References libdap::www2id().

Referenced by libdap::DDS::var().

Here is the call graph for this function:

BaseType * libdap::Structure::var ( const string &  n,
btp_stack s 
)
virtual
Deprecated:
See comment in BaseType

Reimplemented from libdap::BaseType.

Definition at line 428 of file Structure.cc.

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

Here is the call graph for this function:

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.

unsigned int libdap::Structure::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 294 of file Structure.cc.

References libdap::Constructor::_vars.

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

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.

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 313 of file Structure.cc.

References libdap::Constructor::_vars.

Member Data Documentation


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