libdap  Updated for version 3.20.6
libdap4 is an implementation of OPeNDAP's DAP protocol.
libdap::Grid Class Reference

Holds the Grid data type. More...

#include <Grid.h>

Inheritance diagram for libdap::Grid:
Inheritance graph

Public Types

typedef stack< BaseType * > btp_stack
 
typedef std::vector< BaseType * >::const_iterator Map_citer
 
typedef std::vector< BaseType * >::iterator Map_iter
 
typedef std::vector< BaseType * >::reverse_iterator Map_riter
 
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 Arrayadd_map (Array *p_new_map, bool add_copy)
 
virtual void add_var (BaseType *bt, Part part)
 
virtual void add_var_nocopy (BaseType *bt, Part part)
 
BaseTypearray_var ()
 Returns the Grid Array. More...
 
virtual unsigned int buf2val (void **)
 Reads the class data. More...
 
virtual bool check_semantics (string &msg, bool all=false)
 Return true if this Grid is well formed. More...
 
virtual void clear_constraint ()
 
virtual void clear_local_data ()
 
virtual int components (bool constrained=false)
 Returns the number of components in the Grid object. More...
 
virtual void compute_checksum (Crc32 &checksum)
 include the data for this variable in the checksum DAP4 includes a checksum with every data response. This method adds the variable's data to that checksum. More...
 
virtual bool d4_ops (BaseType *b, int op)
 Evaluator a relop for DAP4. More...
 
virtual string dataset () const
 Returns the name of the dataset used to create this instance. More...
 
virtual void del_var (const string &name)
 
virtual void del_var (Vars_iter i)
 
virtual bool deserialize (UnMarshaller &um, DDS *dds, bool reuse=false)
 Receive data from the net. More...
 
virtual void deserialize (D4StreamUnMarshaller &um, DMR &dmr)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual int element_count (bool leaves=false)
 Count the members of constructor types. More...
 
virtual std::string FQN () const
 
Arrayget_array ()
 Returns the Grid Array. This method returns the array using an Array*, so no cast is required. More...
 
virtual AttrTableget_attr_table ()
 
Map_iter get_map_iter (int i)
 
virtual BaseTypeget_parent () const
 
BaseTypeget_var_index (int i)
 
Vars_iter get_vars_iter (int i)
 
 Grid (const string &n)
 The Grid constructor. More...
 
 Grid (const string &n, const string &d)
 The Grid constructor. More...
 
 Grid (const Grid &rhs)
 The Grid copy constructor. More...
 
virtual void intern_data (ConstraintEvaluator &eval, DDS &dds)
 
virtual void intern_data ()
 Read data into this variable. More...
 
virtual bool is_constructor_type () const
 Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. More...
 
virtual bool is_dap2_only_type ()
 
virtual bool is_dap4 () const
 
virtual bool is_in_selection ()
 Is this variable part of the current selection? More...
 
virtual bool is_linear ()
 Check to see whether this variable can be printed simply. More...
 
virtual bool is_simple_type () const
 Returns true if the instance is a numeric, string or URL type variable. More...
 
virtual bool is_vector_type () const
 Returns true if the instance is a vector (i.e., array) type variable. More...
 
virtual int length () const
 How many elements are in this variable. More...
 
Map_iter map_begin ()
 Returns an iterator referencing the first Map vector. More...
 
Map_iter map_end ()
 
Map_riter map_rbegin ()
 Returns an iterator referencing the first Map vector. More...
 
Map_riter map_rend ()
 
virtual string name () const
 Returns the name of the class instance. More...
 
Gridoperator= (const Grid &rhs)
 
virtual bool ops (BaseType *b, int op)
 Evaluate relational operators. More...
 
virtual Arrayprepend_map (Array *p_new_map, bool add_copy)
 
void print_dap4 (XMLWriter &xml, bool constrained=false)
 
virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
 Print an ASCII representation of the variable structure. More...
 
virtual void print_val (ostream &out, string space="", bool print_decl_p=true)
 Prints the value of the variable. More...
 
virtual void print_val (FILE *out, string space="", bool print_decl_p=true)
 Prints the value of the variable. More...
 
virtual void print_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 bool projection_yields_grid ()
 
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, then remove them from the object. More...
 
virtual void serialize (D4StreamMarshaller &m, DMR &dmr, bool filter=false)
 Serialize a Constructor. More...
 
virtual void set_array (Array *p_new_arr)
 
virtual void set_attr_table (const AttrTable &at)
 
virtual void set_in_selection (bool state)
 Set the in_selection property. More...
 
virtual void set_is_dap4 (const bool v)
 
virtual void set_length (int)
 Set the number of elements for this variable. 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)
 
virtual void set_type (const Type &t)
 Sets the type of the class instance. More...
 
virtual bool synthesized_p ()
 
virtual string toString ()
 
virtual void transfer_attributes (AttrTable *at_container)
 
virtual std::vector< BaseType * > * transform_to_dap2 (AttrTable *parent_attr_table)
 DAP4 to DAP2 transform. More...
 
virtual void transform_to_dap4 (D4Group *root, Constructor *container)
 DAP2 to DAP4 transform. More...
 
virtual Type type () const
 Returns the type of the class instance. More...
 
virtual string type_name () const
 Returns the type of the class instance as a string. More...
 
virtual unsigned int val2buf (void *, bool)
 Loads class data. More...
 
virtual 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) const
 
virtual D4Attributesattributes ()
 
virtual void set_attributes (D4Attributes *)
 
virtual void set_attributes_nocopy (D4Attributes *)
 

Static Public Member Functions

static AttrTablemake_dropped_vars_attr_table (vector< BaseType *> *dropped_vars)
 

Protected Member Functions

void m_duplicate (const Constructor &s)
 
void m_duplicate (const Grid &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

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

Detailed Description

Holds the Grid data type.

The Grid data type is a collection of an Array and a set of ``Map'' vectors. The Map vectors are one-dimensional arrays corresponding to each dimension of the central Array. Using this scheme, a Grid can represent, in a rectilinear array, data which is not in reality rectilinear. An example will help make it clear.

Assume that the following array contains measurements of some real quantity, conducted at nine different points in space:

A = [ 1  2  3  4 ]
    [ 2  4  6  8 ]
    [ 3  6  9  12]

To locate this Array in the real world, we could note the location of one corner of the grid, and the grid spacing. This would allow us to calculate the location of any of the other points of the Array.

This approach will not work, however, unless the grid spacing is precisely regular. If the distance between Row 1 and Row 2 is not the same as the distance between Row 2 and Row 3, the scheme will break down. The solution is to equip the Array with two Map vectors that define the location of each row or column of the array:

     A = [ 1  2  3  4 ] Row = [ 0 ]
         [ 2  4  6  8 ]       [ 3 ]
         [ 3  6  9  12]       [ 8 ]
Column = [ 0  2  8  27]

The real location of the point in the first row and column of the array is now exactly fixed at (0,0), and the point in the last row and last column is at (8,27).

The Grid data type has two parts: an Array, and a singly-linked list of Map vectors to describe the Array. The access functions for this class include a function to return the Array (get_array()), and a set of functions for cycling through the list of Map vectors.

Todo:

Move, in some sense, the d_map_vars up to Constructor. Look at using Constructor's _var field for these.

Along the same lines as the previous item, consider removing the Part enum and adopting the convention that the first variable added is the array and any subsequent variables are maps.

See also
Array

Definition at line 122 of file Grid.h.

Constructor & Destructor Documentation

◆ Grid() [1/3]

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

The Grid constructor.

The Grid 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 86 of file Grid.cc.

◆ Grid() [2/3]

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

The Grid constructor.

The Grid server-side constructor requires the name of the variable to be created and the dataset name from which this variable is created. Used when creating variables on the server side.

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 100 of file Grid.cc.

◆ Grid() [3/3]

libdap::Grid::Grid ( const Grid rhs)

The Grid copy constructor.

Definition at line 105 of file Grid.cc.

Member Function Documentation

◆ add_map()

Array * libdap::Grid::add_map ( Array p_new_map,
bool  add_as_copy 
)
virtual

Add the given array p_new_map as a new map vector for the Grid.

If add_as_copy, p_new_map will be cloned and the copy added, leaving p_new_map in the control of the caller.

If !add_as_copy, p_new_map will be explicitly added as the new map vector.

The actual Array* in the Grid will be returned, either the address of the COPY if add_as_copy, else p_new_map itself if !add_as_copy.

It is an exception for p_new_map to be null.

Parameters
p_new_mapthe map we want to add
add_as_copywhether to add p_new_map explicitly and take onwership of memory or to add a clone of it and leave control to caller.
Returns
the actual object stored in the Grid, whether p_new_map, or the address of the copy.

Definition at line 455 of file Grid.cc.

◆ add_var()

void libdap::Grid::add_var ( BaseType bt,
Part  part 
)
virtual

Add an array or map to the Grid.

The original version of this method required that the part parameter be present. However, this complicates using the class from a parser (e.g., the schema-based XML parser). I have modified the method so that if part is nil (the default), then the first variable added is the array and subsequent variables are maps. This matches the behavior in the Java DAP implementation.

Parameters
btArray or Map variable
partis this an array or a map. If not present, first bt is the array and subsequent bts are maps.

d_array_var

Reimplemented from libdap::Constructor.

Definition at line 264 of file Grid.cc.

◆ add_var_nocopy()

void libdap::Grid::add_var_nocopy ( BaseType bt,
Part  part 
)
virtual

Add an array or map to the Grid.

Note
The original version of this method required that the part parameter be present. However, this complicates using the class from a parser (e.g., the schema-based XML parser). I have modified the method so that if part is nil (the default), then the first variable added is the array and subsequent variables are maps. This matches the behavior in the Java DAP implementation.
This version of the method does not the BaseType before adding it. The caller must not free the BaseType object.
Parameters
btArray or Map variable
partis this an array or a map. If not present, first bt is the array and subsequent bts are maps.

get_array()

Reimplemented from libdap::Constructor.

Definition at line 330 of file Grid.cc.

◆ array_var()

BaseType * libdap::Grid::array_var ( )

Returns the Grid Array.

Deprecated:
See also
get_array()

Definition at line 501 of file Grid.cc.

◆ attributes()

D4Attributes * libdap::BaseType::attributes ( )
virtualinherited

DAP4 Attribute methods

Definition at line 599 of file BaseType.cc.

◆ buf2val()

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

Reads the class data.

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

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.

◆ check_semantics()

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

Return true if this Grid is well formed.

The array dimensions and number of map vectors must match and both the array and maps must be of simple-type elements.

Reimplemented from libdap::Constructor.

Definition at line 937 of file Grid.cc.

◆ clear_constraint()

void libdap::Grid::clear_constraint ( )
virtual

For each of the Array and Maps in this Grid, call clear_constraint().

Definition at line 736 of file Grid.cc.

◆ clear_local_data()

virtual void libdap::BaseType::clear_local_data ( )
inlinevirtualinherited

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 179 of file BaseType.h.

◆ components()

int libdap::Grid::components ( bool  constrained = false)
virtual

Returns the number of components in the Grid object.

Returns the number of components in the Grid object. This is equal to one plus the number of Map vectors. If there is a constraint expression in effect, the number of dimensions needed may be smaller than the actual number in the stored data. (Or the Array might not even be requested.) In this case, a user can request the smaller number with the constrained flag.

Returns
The number of components in the Grid object.
Parameters
constrainedIf TRUE, the function returns the number of components contained in the constrained Grid. Since a constraint expression might well eliminate one or more of the Grid dimensions, this number can be lower than the actual number of components. If this parameter is FALSE (the default), the actual number of components will be returned.

Definition at line 585 of file Grid.cc.

◆ compute_checksum()

void libdap::Constructor::compute_checksum ( Crc32 checksum)
virtualinherited

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

Parameters
checksumA Crc32 instance that holds the current checksum.

Implements libdap::BaseType.

Definition at line 550 of file Constructor.cc.

◆ d4_ops()

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

Evaluator a relop for DAP4.

This method is used by the filter expression evaluation code in DAP4. Each of the 'data type' classes that support relops must overload this method. In an expression of the form arg1 op arg2, this object is arg1, the parameter 'b' is arg2 and op is the relational operator.

Note
I used the same relop codes for DAP4 as in the DAP2 parser/scanner which makes for some coupling between them, but cuts way down on the duplication of the evaluator logic, which is somewhat involved.
Parameters
bThe second argument in the relational expression
opThe infix relational operator
Returns
True if the expression is true, False otherwise.

Reimplemented in libdap::Str, libdap::Int32, libdap::Float32, libdap::Byte, libdap::Float64, libdap::Int16, libdap::Int64, libdap::UInt64, and libdap::Int8.

Definition at line 1282 of file BaseType.cc.

◆ dataset()

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

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

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

Definition at line 358 of file BaseType.cc.

◆ del_var()

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

◆ deserialize() [1/2]

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

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

◆ deserialize() [2/2]

void libdap::Constructor::deserialize ( D4StreamUnMarshaller um,
DMR dmr 
)
virtualinherited

The DAP4 deserialization method.

Parameters
um
dmr
Exceptions
Erroror InternalErr

Reimplemented from libdap::BaseType.

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

Definition at line 609 of file Constructor.cc.

◆ dump()

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

Definition at line 1033 of file Grid.cc.

◆ element_count()

int libdap::Constructor::element_count ( bool  leaves = false)
virtualinherited

Count the members of constructor types.

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

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

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

◆ FQN()

string libdap::Constructor::FQN ( ) const
virtualinherited

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

◆ get_array()

Array * libdap::Grid::get_array ( )

Returns the Grid Array. This method returns the array using an Array*, so no cast is required.

Returns
A pointer to the Grid's (dependent) data array

Definition at line 518 of file Grid.cc.

◆ get_attr_table()

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

◆ get_map_iter()

Grid::Map_iter libdap::Grid::get_map_iter ( int  i)

Return the iterator for the ith map.

Parameters
ithe index
Returns
The corresponding Vars_iter

Definition at line 563 of file Grid.cc.

◆ get_parent()

BaseType * libdap::BaseType::get_parent ( ) const
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 751 of file BaseType.cc.

◆ get_var_index()

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

◆ get_vars_iter()

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

◆ intern_data() [1/2]

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

◆ intern_data() [2/2]

void libdap::Constructor::intern_data ( )
virtualinherited

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

◆ is_constructor_type()

bool libdap::BaseType::is_constructor_type ( ) const
virtualinherited

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

◆ is_dap2_only_type()

bool libdap::Grid::is_dap2_only_type ( )
virtual

Grid can only be used for DAP2.

Note
This might change depending on just how complex DAP4Array becomes, for example.

Definition at line 246 of file Grid.cc.

◆ is_in_selection()

bool libdap::BaseType::is_in_selection ( )
virtualinherited

Is this variable part of the current selection?

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

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

◆ is_linear()

bool libdap::Constructor::is_linear ( )
virtualinherited

Check to see whether this variable can be printed simply.

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

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

◆ is_simple_type()

bool libdap::BaseType::is_simple_type ( ) const
virtualinherited

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

◆ is_vector_type()

bool libdap::BaseType::is_vector_type ( ) const
virtualinherited

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

◆ length()

virtual int libdap::BaseType::length ( ) const
inlinevirtualinherited

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::D4Sequence, libdap::Vector, libdap::Str, and libdap::D4Opaque.

Definition at line 207 of file BaseType.h.

◆ m_duplicate()

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

Perform a deep copy.

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

Parameters
btThe source object.

Definition at line 86 of file BaseType.cc.

◆ map_begin()

Grid::Map_iter libdap::Grid::map_begin ( )

Returns an iterator referencing the first Map vector.

Definition at line 525 of file Grid.cc.

◆ map_end()

Grid::Map_iter libdap::Grid::map_end ( )

Returns an iterator referencing the end of the list of Map vectors. It does not reference the last Map vector

Definition at line 537 of file Grid.cc.

◆ map_rbegin()

Grid::Map_riter libdap::Grid::map_rbegin ( )

Returns an iterator referencing the first Map vector.

Definition at line 544 of file Grid.cc.

◆ map_rend()

Grid::Map_riter libdap::Grid::map_rend ( )

Returns an iterator referencing the end of the list of Map vectors. It does not reference the last Map vector

Definition at line 554 of file Grid.cc.

◆ name()

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

Returns the name of the class instance.

Definition at line 320 of file BaseType.cc.

◆ ops()

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

Evaluate relational operators.

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

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

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

This function is used by the constraint expression evaluator.

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.
See also
BaseType::d4_ops(BaseType *, int)

Reimplemented in libdap::D4Enum, libdap::Str, libdap::Int32, libdap::Float32, libdap::Byte, libdap::Float64, libdap::UInt32, libdap::D4Opaque, libdap::Int16, libdap::UInt16, libdap::Int64, libdap::UInt64, and libdap::Int8.

Definition at line 1256 of file BaseType.cc.

◆ prepend_map()

Array * libdap::Grid::prepend_map ( Array p_new_map,
bool  add_copy 
)
virtual

Add pMap (or a clone if addAsCopy) to the FRONT of the maps list. This is needed if we are preserving Grid semantics but want to add a new OUTER dimension, whereas add_map appends to the end making a new INNER dimension.

Parameters
p_new_mapthe map to add or copy and add
add_copyif true, copy pMap and add the copy.
Returns
The actual memory stored in the Grid, either pMap (if !add_copy) or the ptr to the clone (if add_copy).

Definition at line 484 of file Grid.cc.

◆ print_dap4()

void libdap::Constructor::print_dap4 ( XMLWriter xml,
bool  constrained = false 
)
virtualinherited

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

◆ print_decl() [1/2]

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

Definition at line 753 of file Grid.cc.

◆ print_decl() [2/2]

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

Definition at line 744 of file Grid.cc.

◆ print_val() [1/2]

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

Reimplemented from libdap::Constructor.

Definition at line 900 of file Grid.cc.

◆ print_val() [2/2]

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

Definition at line 893 of file Grid.cc.

◆ print_xml() [1/2]

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

Reimplemented from libdap::Constructor.

Definition at line 819 of file Grid.cc.

◆ print_xml() [2/2]

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

Reimplemented from libdap::Constructor.

Definition at line 808 of file Grid.cc.

◆ print_xml_writer()

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

Definition at line 847 of file Grid.cc.

◆ projection_yields_grid()

bool libdap::Grid::projection_yields_grid ( )
virtual

Returns TRUE if the current projection will yield a Grid that will pass the check_semantics() function. A Grid that, when projected, will not pass the check_semantics() function must be sent as either a Structure of Arrays or a single Array depending on the projection.

The function first checks to see whether the Array is present. Then, for each dimension in the Array part, the function checks the corresponding Map vector to make sure it is present in the projected Grid. If for each projected dimension in the Array component, there is a matching Map vector, then the Grid is valid.

Returns
TRUE if the projected grid is still a Grid. FALSE otherwise.

Definition at line 692 of file Grid.cc.

◆ ptr_duplicate()

BaseType * libdap::Grid::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 \e 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 116 of file Grid.cc.

◆ read()

bool libdap::Constructor::read ( )
virtualinherited

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

◆ read_p()

bool libdap::BaseType::read_p ( )
virtualinherited

Has this variable been read?

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

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

Definition at line 480 of file BaseType.cc.

◆ send_p()

bool libdap::BaseType::send_p ( )
virtualinherited

Should this variable be sent?

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

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

Definition at line 554 of file BaseType.cc.

◆ serialize() [1/2]

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

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

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

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

@param eval Use this as the constraint expression evaluator.
Parameters
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 504 of file Constructor.cc.

◆ serialize() [2/2]

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

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

◆ set_array()

void libdap::Grid::set_array ( Array p_new_arr)
virtual

Set the Array part of the Grid to point to the memory p_new_arr. Grid takes control of the memory (no copy is made). If there already exists an array portion, the old one will be deleted to avoid leaks.

Note
This code has been modified to use a new storage for the Grid's variables (the storage defined by Constructor).
Parameters
p_new_arrthe object to store as the array part of the grid.

d_array_var

Definition at line 389 of file Grid.cc.

◆ set_attr_table()

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

Set this variable's attribute table.

Parameters
atSource of the attributes.

Definition at line 590 of file BaseType.cc.

◆ set_in_selection()

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

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

◆ set_length()

virtual void libdap::BaseType::set_length ( int  )
inlinevirtualinherited

Set the number of elements for this variable.

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

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

Definition at line 214 of file BaseType.h.

◆ set_name()

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

Sets the name of the class instance.

Reimplemented in libdap::Vector.

Definition at line 344 of file BaseType.cc.

◆ set_parent()

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

◆ set_read_p()

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

Sets the value of the read_p property.

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

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

◆ set_send_p()

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

Definition at line 208 of file Constructor.cc.

◆ set_synthesized_p()

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

◆ set_type()

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

Sets the type of the class instance.

Definition at line 372 of file BaseType.cc.

◆ synthesized_p()

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

◆ toString()

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

◆ transfer_attributes()

void libdap::Grid::transfer_attributes ( AttrTable at_container)
virtual

All the attributes in a AttrTable for a Grid go in AttrTable for the Array.

Parameters
at_container

Reimplemented from libdap::Constructor.

Definition at line 610 of file Grid.cc.

◆ transform_to_dap2()

std::vector< BaseType * > * libdap::BaseType::transform_to_dap2 ( AttrTable parent_attr_table)
virtualinherited

DAP4 to DAP2 transform.

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

Note
For most DAP4 types, in this implementation of DAP2 the corresponding DAP4 type is the same. These types have a different representations in DAP2 and DAP4: Sequences (which are D4Sequences in the DAP4 implementation),
  • Grids (which are semantically subsumed by coverages in DAP4)
  • Arrays (which use shared dimensions in DAP4)

Additionally DAP4 adds the following types:

  • UInt8, Int8, and Char which map to Byte in DAP2.
  • Int64, Unit64 which have no natural representation in DAP2.
  • Opaque Possible Byte stuff[] plus metadata?
  • Enum's can be represented as Int32.
  • Groups, with the exception of the root group "disappear" into the names of their member variables. Specifically the Group name is add as a prefix followed by a "/" separator to the names of all of the Group's member groups variables.
Parameters
TheAttrTable pointer parent_attr_table is used by Groups, which disappear from the DAP2 representation. Their children are returned in the the BAseType vector their attributes are added to parent_attr_table;
Returns
A pointer to a vector of BaseType pointers (right?). In most cases this vector will contain a single pointer but DAP4 types 'disappear' such as Group will return all of their member variables in the vector. DAP4 types with no representation in DAP2 (ex: UInt64) the will return a NULL pointer and so this must be tested!

Reimplemented in libdap::Array, libdap::D4Enum, libdap::D4Group, libdap::D4Opaque, libdap::Byte, libdap::Structure, libdap::Int64, libdap::UInt64, and libdap::Int8.

Definition at line 259 of file BaseType.cc.

◆ transform_to_dap4()

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

Definition at line 148 of file Grid.cc.

◆ type()

Type libdap::BaseType::type ( ) const
virtualinherited

Returns the type of the class instance.

Definition at line 365 of file BaseType.cc.

◆ type_name()

string libdap::BaseType::type_name ( ) const
virtualinherited

Returns the type of the class instance as a string.

Definition at line 379 of file BaseType.cc.

◆ val2buf()

virtual unsigned int libdap::Constructor::val2buf ( void *  val,
bool  reuse 
)
inlinevirtualinherited

Loads class data.

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

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

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.

◆ var() [1/2]

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

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

Reimplemented from libdap::BaseType.

Definition at line 267 of file Constructor.cc.

◆ var() [2/2]

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

Reimplemented from libdap::BaseType.

Definition at line 279 of file Constructor.cc.

◆ var_begin()

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

Returns an iterator referencing the first structure element.

Definition at line 356 of file Constructor.cc.

◆ var_end()

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

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

Definition at line 364 of file Constructor.cc.

◆ var_rbegin()

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

Return a reverse iterator that references the last element.

Definition at line 371 of file Constructor.cc.

◆ var_rend()

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

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

Definition at line 379 of file Constructor.cc.

◆ width()

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

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

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


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