libdap++  Updated for version 3.13.1
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 **)
 Reads the class data. More...
 
virtual bool check_semantics (string &msg, bool all=false)
 Compare an object's current state with the semantics of its type. More...
 
string dataset () const
 Returns the name of the dataset used to create this instance. More...
 
virtual void del_var (const string &name)
 
virtual void del_var (Vars_iter i)
 
virtual bool deserialize (UnMarshaller &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...
 
bool is_dap4 ()
 
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 read 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...
 
void set_is_dap4 (const bool v)
 
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)
 
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 *, bool)
 Loads class data. More...
 
virtual BaseTypevar (const string &name, bool exact_match=true, btp_stack *s=0)
 btp_stack no longer needed; use back pointers (BaseType::get_parent()) 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 (bool constrained=false)
 
virtual ~Structure ()
 

Protected Member Functions

void m_duplicate (const Constructor &s)
 
void m_duplicate (const BaseType &bt)
 Perform a deep copy. More...
 
BaseTypem_exact_match (const string &name, btp_stack *s=0)
 
BaseTypem_leaf_match (const string &name, btp_stack *s=0)
 

Protected Attributes

std::vector< BaseType * > d_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''.

Definition at line 85 of file Structure.h.

Member Typedef Documentation

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

Definition at line 233 of file BaseType.h.

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

Definition at line 55 of file Constructor.h.

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

Definition at line 56 of file Constructor.h.

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

Definition at line 57 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 106 of file Structure.cc.

Referenced by ptr_duplicate().

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

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

The Structure copy constructor.

Definition at line 123 of file Structure.cc.

References libdap::Constructor::m_duplicate().

Here is the call graph for this function:

libdap::Structure::~Structure ( )
virtual

Definition at line 128 of file Structure.cc.

References libdap::Constructor::d_vars.

Member Function Documentation

void libdap::Constructor::add_var ( BaseType bt,
Part  part = nil 
)
virtualinherited

Adds an element to a Constructor.

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

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 321 of file Constructor.cc.

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

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

Here is the call graph for this function:

void libdap::Constructor::add_var_nocopy ( BaseType bt,
Part  part = nil 
)
virtualinherited

Adds an element to a Constructor.

Parameters
btA pointer to thee variable to add to this Constructor.
partNot used by this class, defaults to nil

Reimplemented in libdap::Grid.

Definition at line 346 of file Constructor.cc.

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

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

Here is the call graph for this function:

virtual unsigned int libdap::Constructor::buf2val ( void **  val)
inlinevirtualinherited

Reads the class data into the memory referenced by val. The caller should either allocate enough storage to val to hold the class data or set *val to null. If *val is NULL, memory will be allocated by this function with new(). If the memory is allocated this way, the caller is responsible for deallocating that memory. Array and values for simple types are stored as C would store an array.

Deprecated:
Use value() in the leaf classes.
@param val A pointer to a pointer to the memory into which the
class data will be copied. If the value pointed to is NULL,
memory will be allocated to hold the data, and the pointer
value modified accordingly. The calling program is responsible
for deallocating the memory references by this pointer.

@return The size (in bytes) of the information copied to <i>val</i>.

Implements libdap::BaseType.

Definition at line 102 of file Constructor.h.

bool libdap::Constructor::check_semantics ( string &  msg,
bool  all = false 
)
virtualinherited

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.

Reimplemented in libdap::Grid.

Definition at line 583 of file Constructor.cc.

References libdap::BaseType::check_semantics(), libdap::Constructor::d_vars, 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 275 of file BaseType.cc.

Referenced by libdap::Sequence::read_row(), libdap::Int8::serialize(), libdap::Int64::serialize(), libdap::UInt64::serialize(), libdap::Int16::serialize(), libdap::UInt16::serialize(), libdap::UInt32::serialize(), libdap::Float64::serialize(), libdap::Float32::serialize(), libdap::Byte::serialize(), libdap::Int32::serialize(), libdap::Str::serialize(), libdap::Constructor::serialize(), libdap::Vector::serialize(), and libdap::Grid::serialize().

void libdap::Constructor::del_var ( const string &  n)
virtualinherited

Remove an element from a Constructor.

Parameters
nname of the variable to remove

Definition at line 362 of file Constructor.cc.

References libdap::Constructor::d_vars.

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

void libdap::Constructor::del_var ( Vars_iter  i)
virtualinherited

Definition at line 375 of file Constructor.cc.

References libdap::Constructor::d_vars.

bool libdap::Constructor::deserialize ( UnMarshaller um,
DDS dds,
bool  reuse = false 
)
virtualinherited

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.

Reimplemented in libdap::Sequence, and libdap::Grid.

Definition at line 451 of file Constructor.cc.

References libdap::Constructor::d_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 598 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::Constructor::element_count ( bool  leaves = false)
virtualinherited

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.

Reimplemented in libdap::Grid.

Definition at line 110 of file Constructor.cc.

References libdap::Constructor::d_vars.

Referenced by libdap::Sequence::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 666 of file BaseType.cc.

Referenced by libdap::D4ParserSax2::ddx_start_element(), libdap::D4Group::print_xml_writer(), libdap::Constructor::print_xml_writer(), libdap::Grid::print_xml_writer(), libdap::BaseType::print_xml_writer(), libdap::Array::print_xml_writer_core(), 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 788 of file BaseType.cc.

Referenced by 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 311 of file Constructor.cc.

References libdap::Constructor::d_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 302 of file Constructor.cc.

References libdap::Constructor::d_vars.

void libdap::Constructor::intern_data ( ConstraintEvaluator eval,
DDS dds 
)
virtualinherited

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.

Reimplemented in libdap::Sequence, and libdap::Grid.

Definition at line 402 of file Constructor.cc.

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

Here is the call graph for this function:

bool libdap::BaseType::is_dap4 ( )
inlineinherited

Definition at line 252 of file BaseType.h.

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

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

void libdap::Constructor::m_duplicate ( const Constructor s)
protectedinherited
void libdap::BaseType::m_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=().

BaseType * libdap::Constructor::m_exact_match ( const string &  name,
btp_stack s = 0 
)
protectedinherited

Definition at line 235 of file Constructor.cc.

References libdap::Constructor::d_vars, libdap::BaseType::name(), libdap::Constructor::var(), and libdap::BaseType::var().

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

Here is the call graph for this function:

BaseType * libdap::Constructor::m_leaf_match ( const string &  name,
btp_stack s = 0 
)
protectedinherited

Definition at line 208 of file Constructor.cc.

References libdap::Constructor::d_vars, DBG, libdap::BaseType::name(), and libdap::BaseType::var().

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

Here is the call graph for this function:

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

Definition at line 254 of file BaseType.cc.

Referenced by libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Constructor::check_semantics(), libdap::Grid::check_semantics(), libdap::Sequence::deserialize(), libdap::DDS::exact_match(), libdap::extract_double_array(), libdap::Constructor::intern_data(), libdap::Vector::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::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::D4Group::print_xml_writer(), 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::Grid::transfer_attributes(), libdap::BaseType::transfer_attributes(), libdap::Vector::value(), libdap::rvalue::value_name(), libdap::Constructor::var(), libdap::Grid::var(), libdap::Vector::var(), and libdap::Sequence::var_value().

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

Definition at line 143 of file Structure.cc.

References libdap::Constructor::m_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::Str, libdap::Int32, libdap::Float32, libdap::Float64, libdap::UInt32, libdap::Byte, libdap::Int16, libdap::UInt16, libdap::UInt64, libdap::Int64, and libdap::Int8.

Definition at line 1198 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 470 of file Constructor.cc.

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

Referenced by libdap::Constructor::print_decl(), libdap::Constructor::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 461 of file Constructor.cc.

References libdap::Constructor::print_decl().

Here is the call graph for this function:

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

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.

Reimplemented in libdap::Sequence, and libdap::Grid.

Definition at line 494 of file Constructor.cc.

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

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.

Reimplemented in libdap::Sequence, and libdap::Grid.

Definition at line 502 of file Constructor.cc.

References libdap::Constructor::d_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
Deprecated:

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 536 of file Constructor.cc.

References libdap::XMLWriter::get_doc(), and libdap::Constructor::print_xml_writer().

Here is the call graph for this function:

void libdap::Constructor::print_xml ( FILE *  out,
string  space = "    ",
bool  constrained = false 
)
virtualinherited
Deprecated:

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 525 of file Constructor.cc.

References libdap::XMLWriter::get_doc(), libdap::XMLWriter::get_doc_size(), and libdap::Constructor::print_xml_writer().

Here is the call graph for this function:

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, and libdap::D4Group.

Definition at line 559 of file Constructor.cc.

References libdap::BaseType::get_attr_table(), libdap::AttrTable::get_size(), libdap::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().

Referenced by libdap::Constructor::print_xml().

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

References Structure().

Here is the call graph for this function:

bool libdap::Constructor::read ( )
virtualinherited
Returns
returns false to signify all has been read

Reimplemented from libdap::BaseType.

Definition at line 389 of file Constructor.cc.

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

Referenced by libdap::Constructor::intern_data(), libdap::Grid::intern_data(), libdap::Sequence::read_row(), libdap::Constructor::serialize(), and libdap::Grid::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 638 of file BaseType.cc.

Referenced by libdap::Grid::components(), 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::D4Group::print_xml_writer(), 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::Constructor::serialize ( ConstraintEvaluator eval,
DDS dds,
Marshaller m,
bool  ce_eval = true 
)
virtualinherited

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.

Reimplemented in libdap::Sequence, and libdap::Grid.

Definition at line 416 of file Constructor.cc.

References libdap::Constructor::d_vars, libdap::BaseType::dataset(), libdap::dods_grid_c, libdap::dods_structure_c, libdap::ConstraintEvaluator::eval_selection(), libdap::Constructor::read(), libdap::BaseType::read_p(), 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 674 of file BaseType.cc.

void libdap::Constructor::set_in_selection ( bool  state)
virtualinherited

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

Parameters
stateSet the property value to state.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 625 of file Constructor.cc.

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

Here is the call graph for this function:

void libdap::BaseType::set_is_dap4 ( const bool  v)
inlineinherited

Definition at line 253 of file BaseType.h.

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

Definition at line 224 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

Definition at line 261 of file BaseType.cc.

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

Referenced by libdap::Vector::add_var(), libdap::Vector::add_var_nocopy(), libdap::Array::print_xml_writer_core(), and libdap::Vector::set_name().

Here is the call graph for this function:

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 770 of file BaseType.cc.

Referenced by libdap::Vector::_duplicate(), libdap::Grid::add_map(), libdap::Constructor::add_var(), libdap::Grid::add_var(), libdap::Vector::add_var(), libdap::Constructor::add_var_nocopy(), libdap::Grid::add_var_nocopy(), libdap::Vector::add_var_nocopy(), libdap::DDXParser::ddx_end_document(), libdap::Constructor::m_duplicate(), libdap::Grid::m_duplicate(), libdap::Grid::prepend_map(), libdap::Grid::set_array(), and libdap::Vector::Vector().

void libdap::Constructor::set_read_p ( bool  state)
virtualinherited

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.

Reimplemented in libdap::Grid.

Definition at line 134 of file Constructor.cc.

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

Referenced by libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_one(), libdap::Constructor::read(), libdap::Sequence::read_row(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_one().

Here is the call graph for this function:

void libdap::Constructor::set_send_p ( bool  state)
virtualinherited

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

Parameters
stateThe logical state to set the send_p flag.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 124 of file Constructor.cc.

References libdap::Constructor::d_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 562 of file BaseType.cc.

void libdap::BaseType::set_type ( const Type t)
inherited
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 551 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 205 of file BaseType.cc.

References libdap::BaseType::type_name().

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

Here is the call graph for this function:

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

Transfer attributes from a DAS object into this variable. Because of the rough history of the DAS object and the way that various server code built the DAS, this is necessarily a heuristic process. The intent is that this method will be overridden by handlers that need to look for certain patterns in the DAS (e.g., hdf4's odd variable_dim_n; where n = 0, 1, 2, ...) attribute containers.

There should be a one-to-one mapping between variables and attribute containers. However, in some cases one variable has attributes spread across several top level containers and in some cases one container is used by several variables

Note
This method is technically unnecessary because a server (or client) can easily add attributes directly using the DDS::get_attr_table or BaseType::get_attr_table methods and then poke values in using any of the methods AttrTable provides. This method exists to ease the transition to DDS objects which contain attribute information for the existing servers (Since they all make DAS objects separately from the DDS). They could be modified to use the same AttrTable methods but operate on the AttrTable instances in a DDS/BaseType instead of those in a DAS.
Parameters
at_containerTransfer attributes from this container.
Returns
void

Reimplemented in libdap::Grid.

Definition at line 705 of file BaseType.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::AttrTable::get_name(), libdap::AttrTable::get_type(), libdap::BaseType::name(), and libdap::AttrTable::set_is_global_attribute().

Referenced by libdap::Grid::transfer_attributes().

Here is the call graph for this function:

Type libdap::BaseType::type ( ) const
inherited
virtual unsigned int libdap::Constructor::val2buf ( void *  val,
bool  reuse 
)
inlinevirtualinherited

Store the value pointed to by val in the object's internal buffer. This function does not perform any checks, so users must be sure that the thing pointed to can actually be stored in the object's buffer.

Only simple objects (Int, Float, Byte, and so on) and arrays of these simple objects may be stored using this function. To put data into more complex constructor types, use the functions provided by that class.

Deprecated:
Use set_value() in the leaf classes.
@param val A pointer to the data to be inserted into the class
data buffer.

@param reuse A boolean value, indicating whether the class
internal data storage can be reused or not. If this argument
is TRUE, the class buffer is assumed to be large enough to
hold the incoming data, and it is <i>not</i> reallocated. If
FALSE, new storage is allocated. If the internal buffer has
not been allocated at all, this argument has no effect. This
is currently used only in the Vector class.

@return The size (in bytes) of the information copied from
<i>val</i>.
@see Grid
@see Vector::val2buf  

Implements libdap::BaseType.

Definition at line 99 of file Constructor.h.

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

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 183 of file Constructor.cc.

References libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), and libdap::www2id().

Referenced by libdap::Constructor::m_exact_match(), and libdap::DDS::var().

Here is the call graph for this function:

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

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 195 of file Constructor.cc.

References libdap::Constructor::m_exact_match(), libdap::Constructor::m_leaf_match(), 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 285 of file Constructor.cc.

References libdap::Constructor::d_vars.

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

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

Definition at line 293 of file Constructor.cc.

References libdap::Constructor::d_vars.

unsigned int libdap::Constructor::width ( bool  constrained = false)
virtualinherited
Deprecated:

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.

Reimplemented in libdap::Grid.

Definition at line 165 of file Constructor.cc.

References libdap::Constructor::d_vars.

Member Data Documentation


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