libdap  Updated for version 3.17.0
libdap::Constructor Class Reference

#include <Constructor.h>

Inheritance diagram for libdap::Constructor:

List of all members.

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.
virtual bool check_semantics (string &msg, bool all=false)
 Compare an object's current state with the semantics of its type.
virtual void clear_local_data ()
virtual void compute_checksum (Crc32 &checksum)
 include the data for this variable in the checksum DAP4 includes a checksum with every data response. This method adds the variable's data to that checksum.
virtual string dataset () const
 Returns the name of the dataset used to create this instance.
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.
virtual void deserialize (D4StreamUnMarshaller &um, DMR &dmr)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int element_count (bool leaves=false)
 Count the members of constructor types.
virtual std::string FQN () const
virtual AttrTableget_attr_table ()
virtual BaseTypeget_parent () const
BaseTypeget_var_index (int i)
Vars_iter get_vars_iter (int i)
virtual void intern_data (ConstraintEvaluator &eval, DDS &dds)
virtual void intern_data ()
 Read data into this variable.
virtual bool is_constructor_type () const
 Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable.
virtual bool is_dap4 () const
virtual bool is_in_selection ()
 Is this variable part of the current selection?
virtual bool is_linear ()
 Check to see whether this variable can be printed simply.
virtual bool is_simple_type () const
 Returns true if the instance is a numeric, string or URL type variable.
virtual bool is_vector_type () const
 Returns true if the instance is a vector (i.e., array) type variable.
virtual int length () const
 How many elements are in this variable.
virtual string name () const
 Returns the name of the class instance.
Constructoroperator= (const Constructor &rhs)
virtual bool ops (BaseType *b, int op)
 Evaluate relational operators.
void print_dap4 (XMLWriter &xml, bool constrained=false)
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure.
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.
virtual void print_val (FILE *out, string space="", bool print_decl_p=true)
 Prints the value of the variable.
virtual void print_val (ostream &out, string space="", bool print_decl_p=true)
 Prints the value of the variable.
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 ()=0
virtual bool read ()
 simple implementation of read that iterates through vars and calls read on them
virtual bool read_p ()
 Has this variable been read?
virtual bool send_p ()
 Should this variable be sent?
virtual bool serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
 Move data to the net, then remove them from the object.
virtual void serialize (D4StreamMarshaller &m, DMR &dmr, bool filter=false)
 Serialize a Constructor.
virtual void set_attr_table (const AttrTable &at)
virtual void set_in_selection (bool state)
 Set the in_selection property.
virtual void set_is_dap4 (const bool v)
virtual void set_length (int)
 Set the number of elements for this variable.
virtual void set_name (const string &n)
 Sets the name of the class instance.
virtual void set_parent (BaseType *parent)
virtual void set_read_p (bool state)
 Sets the value of the read_p property.
virtual void set_send_p (bool state)
virtual void set_synthesized_p (bool state)
virtual void set_type (const Type &t)
 Sets the type of the class instance.
virtual bool synthesized_p ()
virtual string toString ()
virtual void transfer_attributes (AttrTable *at)
BaseTypetransform_to_dap4 (D4Group *root, Constructor *dest)
 DAP2 to DAP4 transform.
virtual Type type () const
 Returns the type of the class instance.
virtual string type_name () const
 Returns the type of the class instance as a string.
virtual unsigned int val2buf (void *, bool)
 Loads class data.
virtual BaseTypevar (const string &name, bool exact_match=true, btp_stack *s=0)
 btp_stack no longer needed; use back pointers (BaseType::get_parent())
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) const
virtual D4Attributesattributes ()
virtual void set_attributes (D4Attributes *)
virtual void set_attributes_nocopy (D4Attributes *)

Protected Member Functions

 Constructor (const string &name, const Type &type, bool is_dap4=false)
 Constructor (const string &name, const string &d, const Type &type, bool is_dap4=false)
 Constructor (const Constructor &copy_from)
void m_duplicate (const Constructor &s)
void m_duplicate (const BaseType &bt)
 Perform a deep copy.
BaseTypem_exact_match (const string &name, btp_stack *s=0)
BaseTypem_leaf_match (const string &name, btp_stack *s=0)

Protected Attributes

bool d_in_selection
bool d_is_synthesized
std::vector< BaseType * > d_vars

Detailed Description

Common methods for all constructor types.

Definition at line 43 of file Constructor.h.


Constructor & Destructor Documentation

libdap::Constructor::Constructor ( const string &  name,
const string &  dataset,
const Type type,
bool  is_dap4 = false 
) [protected]

Server-side constructor that takes the name of the variable to be created, the dataset name from which this variable is being created, and the type of data being stored in the Constructor. This is a protected constructor, available only to derived classes of Constructor

Parameters:
namestring containing the name of the variable to be created
datasetstring containing the name of the dataset from which this variable is being created
typetype of data being stored

Definition at line 102 of file Constructor.cc.


Member Function Documentation

void libdap::Constructor::add_var ( BaseType bt,
Part  part = nil 
) [virtual]

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 382 of file Constructor.cc.

void libdap::Constructor::add_var_nocopy ( BaseType bt,
Part  part = nil 
) [virtual]

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 from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 407 of file Constructor.cc.

D4Attributes * libdap::BaseType::attributes ( ) [virtual, inherited]

DAP4 Attribute methods

Definition at line 539 of file BaseType.cc.

virtual unsigned int libdap::Constructor::buf2val ( void **  val) [inline, virtual]

Reads the class data.

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

Deprecated:
Use value() in the leaf classes.
Parameters:
valA 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.
Returns:
The size (in bytes) of the information copied to val.

Implements libdap::BaseType.

Definition at line 118 of file Constructor.h.

bool libdap::Constructor::check_semantics ( string &  msg,
bool  all = false 
) [virtual]

Compare an object's current state with the semantics of its type.

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

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

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

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 764 of file Constructor.cc.

virtual void libdap::BaseType::clear_local_data ( ) [inline, virtual, inherited]

Remove any read or set data in the private data of the variable, setting read_p() to false. Used to clear any dynamically allocated storage that holds (potentially large) data. For the simple types, this no-op version is all that's needed. Vector and some other classes define a special version and have serialize() implementations that call it to free data as soon as possible after sending it.

Note:
Added 7/5/15 jhrg
Any specialization of this should make sure to reset the read_p property.

Reimplemented in libdap::Sequence, libdap::Vector, libdap::D4Sequence, and libdap::D4Opaque.

Definition at line 178 of file BaseType.h.

void libdap::Constructor::compute_checksum ( Crc32 checksum) [virtual]

include the data for this variable in the checksum DAP4 includes a checksum with every data response. This method adds the variable's data to that checksum.

Parameters:
checksumA Crc32 instance that holds the current checksum.

Implements libdap::BaseType.

Definition at line 525 of file Constructor.cc.

string libdap::BaseType::dataset ( ) const [virtual, inherited]

Returns the name of the dataset used to create this instance.

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

Definition at line 298 of file BaseType.cc.

void libdap::Constructor::del_var ( const string &  n) [virtual]

Remove an element from a Constructor.

Parameters:
nname of the variable to remove

Definition at line 423 of file Constructor.cc.

bool libdap::Constructor::deserialize ( UnMarshaller um,
DDS dds,
bool  reuse = false 
) [virtual]

Receive data from the net.

Receives data from the network connection identified by the source parameter. The data is put into the class data buffer according to the input dds.

This function is only used on the client side of the DODS client/server connection.

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

Reimplemented from libdap::BaseType.

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

Definition at line 515 of file Constructor.cc.

void libdap::Constructor::deserialize ( D4StreamUnMarshaller um,
DMR dmr 
) [virtual]

The DAP4 deserialization method.

Parameters:
um
dmr
Exceptions:
Erroror InternalErr

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Sequence, and libdap::D4Group.

Definition at line 584 of file Constructor.cc.

void libdap::Constructor::dump ( ostream &  strm) const [virtual]

dumps information about this object

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::BaseType.

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

Definition at line 824 of file Constructor.cc.

int libdap::Constructor::element_count ( bool  leaves = false) [virtual]

Count the members of constructor types.

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

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

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 169 of file Constructor.cc.

string libdap::Constructor::FQN ( ) const [virtual]

Return the FQN for this variable. This will include the D4 Group component of the name.

Returns:
The FQN in a string

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 156 of file Constructor.cc.

AttrTable & libdap::BaseType::get_attr_table ( ) [virtual, inherited]

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

BaseType * libdap::BaseType::get_parent ( ) const [virtual, inherited]

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

Return the BaseType pointer for the ith variable.

Parameters:
iThis index
Returns:
The corresponding BaseType*.

Definition at line 372 of file Constructor.cc.

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

Return the iterator for the ith variable.

Parameters:
ithe index
Returns:
The corresponding Vars_iter

Definition at line 363 of file Constructor.cc.

void libdap::Constructor::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. Unlike serialize(), this method does not clear the memory use to hold the data values, so the caller should make sure to delete the DDS or the variable as soon as possible.

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::D4Sequence.

Definition at line 465 of file Constructor.cc.

Read data into this variable.

Parameters:
evalEvaluator for a constraint expression
dmrDMR for the whole dataset

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Sequence, and libdap::D4Group.

Definition at line 531 of file Constructor.cc.

bool libdap::BaseType::is_constructor_type ( ) const [virtual, inherited]

Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable.

Returns:
True if the instance is a Structure, Sequence or Grid, False otherwise.

Definition at line 352 of file BaseType.cc.

bool libdap::BaseType::is_in_selection ( ) [virtual, inherited]

Is this variable part of the current selection?

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

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

bool libdap::Constructor::is_linear ( ) [virtual]

Check to see whether this variable can be printed simply.

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

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 in libdap::Sequence, and libdap::Structure.

Definition at line 795 of file Constructor.cc.

bool libdap::BaseType::is_simple_type ( ) const [virtual, inherited]

Returns true if the instance is a numeric, string or URL type variable.

Returns:
True if the instance is a scalar numeric, String or URL variable, False otherwise. Arrays (even of simple types) return False.
See also:
is_vector_type()

Definition at line 333 of file BaseType.cc.

bool libdap::BaseType::is_vector_type ( ) const [virtual, inherited]

Returns true if the instance is a vector (i.e., array) type variable.

Returns:
True if the instance is an Array, False otherwise.

Definition at line 342 of file BaseType.cc.

virtual int libdap::BaseType::length ( ) const [inline, virtual, inherited]

How many elements are in this variable.

Todo:
change the return type to int64_t
Returns:
The number of elements; 1 for scalars

Reimplemented in libdap::Sequence, libdap::Vector, libdap::D4Sequence, libdap::Str, and libdap::D4Opaque.

Definition at line 206 of file BaseType.h.

void libdap::BaseType::m_duplicate ( const BaseType bt) [protected, inherited]

Perform a deep copy.

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

Parameters:
btThe source object.

Definition at line 85 of file BaseType.cc.

string libdap::BaseType::name ( ) const [virtual, inherited]

Returns the name of the class instance.

Definition at line 260 of file BaseType.cc.

bool libdap::BaseType::ops ( BaseType b,
int  op 
) [virtual, inherited]

Evaluate relational operators.

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

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

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

This function is used by the constraint expression evaluator.

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

Definition at line 1170 of file BaseType.cc.

void libdap::Constructor::print_dap4 ( XMLWriter xml,
bool  constrained = false 
) [virtual]

Write the DAP4 XML representation for this variable. This method is used to build the DAP4 DMR response object.

Parameters:
xmlAn XMLWriter that will do the serialization
constrainedTrue if the response should show the variables subject to the current constraint expression.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 740 of file Constructor.cc.

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

Print an ASCII representation of the variable structure.

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

A simple array declaration might look like this:

    Float64 lat[lat = 180];
    

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

    Grid {
    ARRAY:
    Int32 sst[time = 404][lat = 180][lon = 360];
    MAPS:
    Float64 time[time = 404];
    Float64 lat[lat = 180];
    Float64 lon[lon = 360];
    } sst;
    
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 601 of file Constructor.cc.

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

Print an ASCII representation of the variable structure.

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

A simple array declaration might look like this:

    Float64 lat[lat = 180];
    

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

    Grid {
    ARRAY:
    Int32 sst[time = 404][lat = 180][lon = 360];
    MAPS:
    Float64 time[time = 404];
    Float64 lat[lat = 180];
    Float64 lon[lon = 360];
    } sst;
    
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 592 of file Constructor.cc.

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

Prints the value of the variable.

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

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.

Reimplemented from libdap::BaseType.

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

Definition at line 625 of file Constructor.cc.

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

Prints the value of the variable.

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

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

Definition at line 633 of file Constructor.cc.

void libdap::Constructor::print_xml ( ostream &  out,
string  space = "    ",
bool  constrained = false 
) [virtual]
Deprecated:

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 667 of file Constructor.cc.

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

Reimplemented from libdap::BaseType.

Reimplemented in libdap::Grid.

Definition at line 656 of file Constructor.cc.

void libdap::Constructor::print_xml_writer ( XMLWriter xml,
bool  constrained = false 
) [virtual]

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 690 of file Constructor.cc.

virtual BaseType* libdap::BaseType::ptr_duplicate ( ) [pure virtual, inherited]

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.

Implemented in libdap::Sequence, libdap::Array, libdap::D4Sequence, libdap::Grid, libdap::Vector, libdap::D4Enum, libdap::Structure, libdap::Int32, libdap::Url, libdap::Byte, libdap::Str, libdap::D4Group, libdap::Float32, libdap::Float64, libdap::Int16, libdap::UInt32, libdap::UInt16, libdap::Int64, libdap::UInt64, libdap::Int8, and libdap::D4Opaque.

bool libdap::Constructor::read ( ) [virtual]

simple implementation of read that iterates through vars and calls read on them

Returns:
returns false to signify all has been read

Reimplemented from libdap::BaseType.

Definition at line 451 of file Constructor.cc.

bool libdap::BaseType::read_p ( ) [virtual, inherited]

Has this variable been read?

Returns true if the value(s) for this variable have been read from the data source, otherwise returns false. This method is used to determine when values need to be read using the read() method. When read_p() returns true, this library assumes that buf2val() (and other methods such as get_vec()) can be used to access the value(s) of a variable.

Returns:
True if the variable's value(s) have been read, false otherwise.

Definition at line 420 of file BaseType.cc.

bool libdap::BaseType::send_p ( ) [virtual, inherited]

Should this variable be sent?

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

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

Definition at line 494 of file BaseType.cc.

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

Move data to the net, then remove them from the object.

Sends the data from the indicated (local) dataset through the connection identified by the Marshaller parameter. If the data is not already incorporated into the DDS object, read the data from the dataset. Once the data are sent (written to the Marshaller), they are deleted from the object and the object state is reset so that they will be read again if the read() method is called.

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

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 the dds.
Returns:
This method always returns true. Older versions used the return value to signal success or failure.
Note:
We changed the default behavior of this method so that it calls BaseType::clear_local_data() once the values are sent. This, combined with the behavior that read() is called by this method just before data are sent, means that data for any given variable remain in memory for the shortest time possible. Furthermore, since variables are serialized one at a time, no more than one variable's data will be in memory at any given time when using the default behavior. Some code - code that uses intern_data() or server functions - might alter this default behavior. Only Array (i.e. Vector), Sequence, D4Sequence and D4Opaque types actually hold data in dynamically allocated memory, so sonly those types have the new/changed behavior. This change was made on 7/5/15.
Exceptions:
InternalErr.
Error.
See also:
DDS

Reimplemented from libdap::BaseType.

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

Definition at line 479 of file Constructor.cc.

void libdap::Constructor::serialize ( D4StreamMarshaller m,
DMR dmr,
bool  filter = false 
) [virtual]

Serialize a Constructor.

Todo:
See notebook for 8/21/14
Parameters:
m
dmrUnused
evalUnused
filterUnused
Exceptions:
Erroris thrown if the value needs to be read and that operation fails.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Sequence, and libdap::D4Group.

Definition at line 553 of file Constructor.cc.

void libdap::BaseType::set_attr_table ( const AttrTable at) [virtual, inherited]

Set this variable's attribute table.

Parameters:
atSource of the attributes.

Definition at line 530 of file BaseType.cc.

void libdap::Constructor::set_in_selection ( bool  state) [virtual]

Set the in_selection property.

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 806 of file Constructor.cc.

virtual void libdap::BaseType::set_length ( int  ) [inline, virtual, inherited]

Set the number of elements for this variable.

Todo:
change param type to int64_t
Parameters:
lThe number of elements

Reimplemented in libdap::Vector, and libdap::D4Sequence.

Definition at line 213 of file BaseType.h.

void libdap::BaseType::set_name ( const string &  n) [virtual, inherited]

Sets the name of the class instance.

Reimplemented in libdap::Vector.

Definition at line 284 of file BaseType.cc.

void libdap::BaseType::set_parent ( BaseType parent) [virtual, inherited]

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

void libdap::Constructor::set_read_p ( bool  state) [virtual]

Sets the value of the read_p property.

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

Note:
If the is_synthesized property is true, this method will _not_ alter the is_read property. If you need that behavior, specialize the method in your subclasses if the various types.
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_p() 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!
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::D4Group.

Definition at line 193 of file Constructor.cc.

void libdap::Constructor::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 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::D4Group.

Definition at line 183 of file Constructor.cc.

void libdap::BaseType::set_synthesized_p ( bool  state) [virtual, inherited]

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

void libdap::BaseType::set_type ( const Type t) [virtual, inherited]

Sets the type of the class instance.

Definition at line 312 of file BaseType.cc.

bool libdap::BaseType::synthesized_p ( ) [virtual, inherited]

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

string libdap::BaseType::toString ( ) [virtual, inherited]

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

void libdap::BaseType::transfer_attributes ( AttrTable at_container) [virtual, inherited]

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

BaseType * libdap::Constructor::transform_to_dap4 ( D4Group root,
Constructor container 
) [virtual]

DAP2 to DAP4 transform.

For the current BaseType, return a DAP4 'copy' of the variable.

Note:
For most DAP2 types, in this implementation of DAP4 the corresponding DAP4 type is the same. The different types are Sequences (which are D4Sequences in the DAP4 implementation), Grids (which are coverages) and Arrays (which use shared dimensions).
Parameters:
rootThe root group that should hold this new variable. Add Group-level stuff here (e.g., D4Dimensions).
containerAdd the new variable to this container.
Returns:
A pointer to the transformed variable

Reimplemented from libdap::BaseType.

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

Definition at line 137 of file Constructor.cc.

Type libdap::BaseType::type ( ) const [virtual, inherited]

Returns the type of the class instance.

Definition at line 305 of file BaseType.cc.

string libdap::BaseType::type_name ( ) const [virtual, inherited]

Returns the type of the class instance as a string.

Definition at line 319 of file BaseType.cc.

virtual unsigned int libdap::Constructor::val2buf ( void *  val,
bool  reuse 
) [inline, virtual]

Loads class data.

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

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

Deprecated:
Use set_value() in the leaf classes.
Parameters:
valA pointer to the data to be inserted into the class data buffer.
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. This is currently used only in the Vector class.
Returns:
The size (in bytes) of the information copied from val.
See also:
Grid
Vector::val2buf

Implements libdap::BaseType.

Definition at line 115 of file Constructor.h.

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

btp_stack no longer needed; use back pointers (BaseType::get_parent())

Reimplemented from libdap::BaseType.

Definition at line 242 of file Constructor.cc.

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

Reimplemented from libdap::BaseType.

Definition at line 254 of file Constructor.cc.

Constructor::Vars_iter libdap::Constructor::var_begin ( )

Returns an iterator referencing the first structure element.

Definition at line 331 of file Constructor.cc.

Constructor::Vars_iter libdap::Constructor::var_end ( )

Returns an iterator referencing the end of the list of structure elements. Does not reference the last structure element.

Definition at line 339 of file Constructor.cc.

Constructor::Vars_riter libdap::Constructor::var_rbegin ( )

Return a reverse iterator that references the last element.

Definition at line 346 of file Constructor.cc.

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

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

Definition at line 354 of file Constructor.cc.

unsigned int libdap::Constructor::width ( bool  constrained = false) const [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 224 of file Constructor.cc.


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