Holds the Grid data type. More...

#include <Grid.h>

Inheritance diagram for libdap::Grid:

Collaboration diagram for libdap::Grid:

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 Array *	add_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)

BaseType *	array_var ()
	Returns the Grid Array.

unsigned int	buf2val (void **) override
	Reads the class data.

virtual bool	check_semantics (string &msg, bool all=false)
	Return true if this Grid is well formed.

virtual void	clear_constraint ()

virtual void	clear_local_data ()

virtual int	components (bool constrained=false)
	Returns the number of components in the Grid object.

void	compute_checksum (Crc32 &checksum) override
	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 bool	d4_ops (BaseType *b, int op)
	Evaluator a relop for DAP4.

virtual string	dataset () const
	Returns the name of the dataset used to create this instance.

virtual void	del_var (const string &name)
	Remove an element from a Constructor.

virtual void	del_var (Vars_iter i)
	Delete the BaseType* and erase the iterator .

void	deserialize (D4StreamUnMarshaller &um, DMR &dmr) override

bool	deserialize (UnMarshaller &um, DDS *dds, bool reuse=false) override
	Receive data from the net.

virtual void	dump (ostream &strm) const
	dumps information about this object

int	element_count (bool leaves=false) override
	Count the members of constructor types.

std::string	FQN () const override

virtual BaseType *	get_ancestor ()

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

virtual AttrTable &	get_attr_table ()

Map_iter	get_map_iter (int i)

virtual BaseType *	get_parent () const

BaseType *	get_var_index (int i)

Vars_iter	get_vars_iter (int i)

	Grid (const Grid &rhs)
	The Grid copy constructor.

	Grid (const string &n)
	The Grid constructor.

	Grid (const string &n, const string &d)
	The Grid constructor.

void	intern_data () override
	Read data into this variable.

void	intern_data (ConstraintEvaluator &eval, DDS &dds) override

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

virtual bool	is_dap4 () const

bool	is_dap4_projected (std::vector< std::string > &inventory) override

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? Uses -1 in places.

virtual int64_t	length_ll () const
	Get the number of elements in this variable This version of the function deprecates length() which is limited to 32-bit sizes. The field uses -1 as a sentinel value indicating that a Vector/Array holds no values yet (as opposed to zero values). For types not derived from Vector, there is always one element.

Map_iter	map_begin ()
	Returns an iterator referencing the first Map vector.

Map_iter	map_end ()

Map_riter	map_rbegin ()
	Returns an iterator referencing the first Map vector.

Map_riter	map_rend ()

virtual string	name () const
	Returns the name of the class instance.

Grid &	operator= (const Grid &rhs)

virtual bool	ops (BaseType *b, int op)
	Evaluate relational operators.

virtual Array *	prepend_map (Array *p_new_map, bool add_copy)

void	print_dap4 (XMLWriter &xml, bool constrained=false) override

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_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_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 (FILE *out, string space=" ", bool constrained=false)

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

virtual void	print_xml_writer (XMLWriter &xml, bool constrained=false)

virtual bool	projection_yields_grid ()

virtual BaseType *	ptr_duplicate ()

bool	read () override
	Read the elements of Constructor marked for transmission.

virtual bool	read_p ()
	Has this variable been read?

virtual bool	send_p ()
	Should this variable be sent?

bool	serialize (ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) override
	Move data to the net, then remove them from the object.

void	serialize (D4StreamMarshaller &m, DMR &dmr, bool filter=false) override
	Serialize a Constructor.

virtual void	set_array (Array *p_new_arr)

virtual void	set_attr_table (const AttrTable &at)

void	set_in_selection (bool state) override
	Set the in_selection property.

virtual void	set_is_dap4 (const bool v)

virtual void	set_length (int64_t)
	Set the number of elements for this variable. use -1 to indicate nothing set.

virtual void	set_length_ll (int64_t)
	Set the number of elements in this variable This version of the function deprecates set_length() which is limited to 32-bit sizes. The field uses -1 as a sentinel value indicating that the Vector/Array holds no values.

virtual void	set_name (const string &n)
	Sets the name of the class instance.

virtual void	set_parent (BaseType *parent)

void	set_read_p (bool state) override
	Set the 'read_p' property for the Constructor and its members.

void	set_send_p (bool state) override

virtual void	set_synthesized_p (bool state)

virtual void	set_type (const Type &t)
	Sets the type of the class instance.

void	set_var_index (BaseType *bt, int i)
	Set the ith element of d_vars to a variable object.

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.

virtual void	transform_to_dap4 (D4Group root, Constructor container)
	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.

unsigned int	val2buf (void *, bool) override
	Loads class data.

BaseType *	var (const string &n, btp_stack &s) override

BaseType *	var (const string &name, bool exact_match=true, btp_stack *s=nullptr) override
	btp_stack no longer needed; use back pointers (BaseType::get_parent())

Vars_iter	var_begin ()

Vars_iter	var_end ()

Vars_riter	var_rbegin ()

Vars_riter	var_rend ()

const vector< BaseType * > &	variables () const

unsigned int	width (bool constrained=false) const override

int64_t	width_ll (bool constrained=false) const override
	Get the width of the Constructor's fields.

virtual	~Grid ()


virtual D4Attributes *	attributes ()

virtual void	set_attributes (D4Attributes *)

virtual void	set_attributes_nocopy (D4Attributes *)

Static Public Member Functions
static AttrTable *	make_dropped_vars_attr_table (vector< BaseType * > *dropped_vars)

Protected Member Functions
void	m_duplicate (const BaseType &bt)
	Perform a deep copy.

void	m_duplicate (const Grid &s)

BaseType *	m_exact_match (const string &name, btp_stack *s=nullptr)

BaseType *	m_leaf_match (const string &name, btp_stack *s=nullptr)

Protected Attributes
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 121 of file Grid.h.

Member Typedef Documentation

◆ btp_stack

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

inherited

Definition at line 149 of file BaseType.h.

◆ Map_citer

typedef std::vector<BaseType*>::const_iterator libdap::Grid::Map_citer

Definition at line 135 of file Grid.h.

◆ Map_iter

typedef std::vector<BaseType*>::iterator libdap::Grid::Map_iter

Definition at line 136 of file Grid.h.

◆ Map_riter

typedef std::vector<BaseType*>::reverse_iterator libdap::Grid::Map_riter

Definition at line 137 of file Grid.h.

◆ Vars_citer

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

inherited

Definition at line 59 of file Constructor.h.

◆ Vars_iter

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

inherited

Definition at line 60 of file Constructor.h.

◆ Vars_riter

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

inherited

Definition at line 61 of file Constructor.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

n	A string containing the name of the variable to be created.

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

n	A string containing the name of the variable to be created.
d	A string containing the name of the dataset from which this variable is being created.

Definition at line 87 of file Grid.cc.

◆ Grid() [3/3]

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

The Grid copy constructor.

Definition at line 90 of file Grid.cc.

◆ ~Grid()

libdap::Grid::~Grid ( )

virtual

Definition at line 92 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_map	the map we want to add
add_as_copy	whether 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 399 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

bt	Array or Map variable
part	is this an array or a map. If not present, first `bt` is the array and subsequent `bt`s are maps.

d_array_var

Reimplemented from libdap::Constructor.

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

bt	Array or Map variable
part	is this an array or a map. If not present, first `bt` is the array and subsequent `bt`s are maps.

get_array()

Reimplemented from libdap::Constructor.

Definition at line 283 of file Grid.cc.

◆ array_var()

BaseType * libdap::Grid::array_var ( )

Returns the Grid Array.

Deprecated

See also: get_array()

Definition at line 440 of file Grid.cc.

◆ attributes()

D4Attributes * libdap::BaseType::attributes ( )

virtualinherited

DAP4 Attribute methods

Definition at line 507 of file BaseType.cc.

◆ buf2val()

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

inlineoverridevirtualinherited

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

val	A pointer to a pointer to the memory into which the class data will be copied. If the value pointed to is NULL, memory will be allocated to hold the data, and the pointer value modified accordingly. The calling program is responsible for deallocating the memory references by this pointer.

Returns: The size (in bytes) of the information copied to val.

Implements libdap::BaseType.

Definition at line 137 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 806 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 633 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::D4Opaque, libdap::D4Sequence, libdap::Sequence, and libdap::Vector.

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

constrained If 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 490 of file Grid.cc.

◆ compute_checksum()

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

overridevirtualinherited

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

checksum A Crc32 instance that holds the current checksum.

Implements libdap::BaseType.

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

b	The second argument in the relational expression
op	The infix relational operator

Returns: True if the expression is true, False otherwise.

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

Definition at line 1125 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 326 of file BaseType.cc.

◆ del_var() [1/2]

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

virtualinherited

Remove an element from a Constructor.

Note: New version. There is a subtle change in that this version will remove all variables in this Constructor with name 'n' while the old version would just remove the first variable.

Parameters

n	name of the variable to remove

Definition at line 359 of file Constructor.cc.

◆ del_var() [2/2]

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

virtualinherited

Delete the BaseType* and erase the iterator .

Note: It is OK to call this with an iterator that points to nullptr.

Parameters

i	The iterator that points to the BaseType.

Definition at line 370 of file Constructor.cc.

◆ deserialize() [1/2]

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

overridevirtualinherited

The DAP4 deserialization method.

Parameters

um
dmr

Exceptions

Error or InternalErr

Reimplemented from libdap::BaseType.

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

Definition at line 500 of file Constructor.cc.

◆ deserialize() [2/2]

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

overridevirtualinherited

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

um	An UnMarshaller that knows how to deserialize data types
dds	The 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.
reuse	A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is 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

Error when a problem reading from the UnMarshaller is found.

See also: DDS

Reimplemented from libdap::BaseType.

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

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

strm	C++ i/o stream to dump the information to

Returns: void

Reimplemented from libdap::Constructor.

Definition at line 904 of file Grid.cc.

◆ element_count()

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

overridevirtualinherited

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

leaves This 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 109 of file Constructor.cc.

◆ FQN()

string libdap::Constructor::FQN ( ) const

overridevirtualinherited

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

◆ get_ancestor()

BaseType * libdap::BaseType::get_ancestor ( )

virtualinherited

Definition at line 638 of file BaseType.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 445 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 498 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

i the index

Returns: The corresponding Vars_iter

Definition at line 473 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 636 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

i	This index

Returns: The corresponding BaseType*.

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

i the index

Returns: The corresponding Vars_iter

Definition at line 285 of file Constructor.cc.

◆ intern_data() [1/2]

void libdap::Constructor::intern_data ( )

overridevirtualinherited

Read data into this variable.

Parameters

eval	Evaluator for a constraint expression
dmr	DMR for the whole dataset

Reimplemented from libdap::BaseType.

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

Definition at line 457 of file Constructor.cc.

◆ intern_data() [2/2]

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

overridevirtualinherited

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.

Note: This version of the method is specific to DAP2. It will throw an exception if called on a variable where the is_dap4 property is true.

Parameters

eval	Use this as the constraint expression evaluator.
dds	The 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::D4Sequence, and libdap::Sequence.

Definition at line 399 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 358 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 202 of file Grid.cc.

◆ is_dap4()

virtual bool libdap::BaseType::is_dap4 ( ) const

inlinevirtualinherited

Definition at line 181 of file BaseType.h.

◆ is_dap4_projected()

bool libdap::Constructor::is_dap4_projected ( std::vector< std::string > & inventory )

overridevirtualinherited

When send_p() is true and the attributes or variables contain dap4 data types then a description of the instance is added to the inventory and true is returned.

Parameters

inventory is a value-result parameter

Returns: True when send_p() is true and this object contains dap4 types variables or attributes, false otherwise

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 722 of file Constructor.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 600 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.

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

◆ length()

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

inlinevirtualinherited

How many elements are in this variable? Uses -1 in places.

Returns: The number of elements; 1 for scalars

Deprecated: Use length_ll() instead

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

Definition at line 207 of file BaseType.h.

◆ length_ll()

virtual int64_t libdap::BaseType::length_ll ( ) const

inlinevirtualinherited

Get the number of elements in this variable This version of the function deprecates length() which is limited to 32-bit sizes. The field uses -1 as a sentinel value indicating that a Vector/Array holds no values yet (as opposed to zero values). For types not derived from Vector, there is always one element.

Returns: The number of elements in this variable

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

Definition at line 216 of file BaseType.h.

◆ m_duplicate() [1/2]

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

bt	The source object.

Definition at line 85 of file BaseType.cc.

◆ m_duplicate() [2/2]

void libdap::Grid::m_duplicate ( const Grid & s )

protected

Definition at line 63 of file Grid.cc.

◆ m_exact_match()

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

protectedinherited

Definition at line 237 of file Constructor.cc.

◆ m_leaf_match()

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

protectedinherited

Definition at line 214 of file Constructor.cc.

◆ make_dropped_vars_attr_table()

AttrTable * libdap::Constructor::make_dropped_vars_attr_table ( vector< BaseType * > * dropped_vars )

staticinherited

Definition at line 675 of file Constructor.cc.

◆ map_begin()

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

Returns an iterator referencing the first Map vector.

Definition at line 448 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 458 of file Grid.cc.

◆ map_rbegin()

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

Returns an iterator referencing the first Map vector.

Definition at line 461 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 468 of file Grid.cc.

◆ name()

string libdap::BaseType::name ( ) const

virtualinherited

Returns the name of the class instance.

Definition at line 296 of file BaseType.cc.

◆ operator=()

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

Definition at line 98 of file Grid.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

b	Compare the value of this instance with b.
op	An 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::Byte, libdap::D4Enum, libdap::D4Opaque, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Int64, libdap::Int8, libdap::Str, libdap::UInt16, libdap::UInt32, and libdap::UInt64.

Definition at line 1101 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_map	the map to add or copy and add
add_copy	if 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 426 of file Grid.cc.

◆ print_dap4()

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

overridevirtualinherited

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

Parameters

xml	An XMLWriter that will do the serialization
constrained	True if the response should show the variables subject to the current constraint expression.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 601 of file Constructor.cc.

◆ print_decl() [1/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

out	The output stream on which to print the declaration.
space	Each line of the declaration will begin with the characters in this string. Usually used for leading spaces.
print_semi	A boolean value indicating whether to print a semicolon at the end of the declaration.
constraint_info	A 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.
constrained	If 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 639 of file Grid.cc.

◆ print_decl() [2/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

out	The output stream on which to print the declaration.
space	Each line of the declaration will begin with the characters in this string. Usually used for leading spaces.
print_semi	A boolean value indicating whether to print a semicolon at the end of the declaration.
constraint_info	A 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.
constrained	If 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 645 of file Grid.cc.

◆ print_val() [1/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

out	The output stream on which to print the value.
space	This value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_p	A boolean value controlling whether the variable declaration is printed as well as the value.

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

out	The output stream on which to print the value.
space	This value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_p	A boolean value controlling whether the variable declaration is printed as well as the value.

Reimplemented from libdap::Constructor.

Definition at line 763 of file Grid.cc.

◆ print_val() [2/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

out	The output ostream on which to print the value.
space	This value is passed to the print_decl() function, and controls the leading spaces of the output.
print_decl_p	A boolean value controlling whether the variable declaration is printed as well as the value.

Reimplemented from libdap::Constructor.

Definition at line 769 of file Grid.cc.

◆ print_xml() [1/2]

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

virtual

Deprecated

Reimplemented from libdap::Constructor.

Definition at line 692 of file Grid.cc.

◆ print_xml() [2/2]

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

virtual

Deprecated

Reimplemented from libdap::Constructor.

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

out	Destination output stream
space	Use this to indent child declarations. Default is "".
constrained	If true, only print this if it's part part of the current projection. Default is False.

Reimplemented from libdap::Constructor.

Definition at line 707 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 592 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 96 of file Grid.cc.

◆ read()

bool libdap::Constructor::read ( )

overridevirtualinherited

Read the elements of Constructor marked for transmission.

Iterate over the top level members of the Constructor and read all of them that have the 'send_p' property set to true. Assume the read() methods correctly set the 'read_p' property. Once done, set 'read_p' for the Constructor itself (but not for the members, that is left up to their individual read() methods).

Returns: returns false; the return value is a relic.

Reimplemented from libdap::BaseType.

Definition at line 386 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 410 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 478 of file BaseType.cc.

◆ serialize() [1/2]

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

overridevirtualinherited

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

eval	Use this as the constraint expression evaluator.
dds	The Data Descriptor Structure object corresponding to this dataset. See The DODS User Manual for information about this structure.
m	A marshaller used to serialize data types
ce_eval	A 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::D4Sequence, and libdap::Sequence.

Definition at line 416 of file Constructor.cc.

◆ serialize() [2/2]

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

overridevirtualinherited

Serialize a Constructor.

Todo: See notebook for 8/21/14

Parameters

m
dmr	Unused
eval	Unused
filter	Unused

Exceptions

Error is thrown if the value needs to be read and that operation fails.

Reimplemented from libdap::BaseType.

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

Definition at line 479 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_arr the object to store as the array part of the grid.

d_array_var

Definition at line 344 of file Grid.cc.

◆ set_attr_table()

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

virtualinherited

Set this variable's attribute table.

Parameters

at	Source of the attributes.

Definition at line 502 of file BaseType.cc.

◆ set_attributes()

void libdap::BaseType::set_attributes ( D4Attributes * attrs )

virtualinherited

Definition at line 513 of file BaseType.cc.

◆ set_attributes_nocopy()

void libdap::BaseType::set_attributes_nocopy ( D4Attributes * attrs )

virtualinherited

Definition at line 515 of file BaseType.cc.

◆ set_in_selection()

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

overridevirtualinherited

Set the in_selection property.

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

Parameters

state Set the property value to state.

Reimplemented from libdap::BaseType.

Definition at line 656 of file Constructor.cc.

◆ set_is_dap4()

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

inlinevirtualinherited

Definition at line 182 of file BaseType.h.

◆ set_length()

virtual void libdap::BaseType::set_length ( int64_t )

inlinevirtualinherited

Set the number of elements for this variable. use -1 to indicate nothing set.

See also: Vector

Parameters

l	The number of elements

Deprecated: Use set_length_ll() instead

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

Definition at line 224 of file BaseType.h.

◆ set_length_ll()

virtual void libdap::BaseType::set_length_ll ( int64_t )

inlinevirtualinherited

Set the number of elements in this variable This version of the function deprecates set_length() which is limited to 32-bit sizes. The field uses -1 as a sentinel value indicating that the Vector/Array holds no values.

Parameters

l	The number of elements in the variable

Reimplemented in libdap::Vector.

Definition at line 232 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 314 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

parent Pointer 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

InternalErr thrown if called with anything other than a Constructor, Vector or Null.

Definition at line 622 of file BaseType.cc.

◆ set_read_p()

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

overridevirtualinherited

Set the 'read_p' property for the Constructor and its members.

This method sets read_p for all of the Constructor. The read() method is much more selective and only sets read_p for the Constructor itself, leaving the value of the property of the members up to their read() methods. Calling this with false will clear the property of all the member variables.

Parameters

state Set the read_p property to this state.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 140 of file Constructor.cc.

◆ set_send_p()

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

overridevirtualinherited

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

state The logical state to set the send_p flag.

Reimplemented from libdap::BaseType.

Reimplemented in libdap::D4Group.

Definition at line 121 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 397 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 332 of file BaseType.cc.

◆ set_var_index()

void libdap::Constructor::set_var_index	(	BaseType *	bt,
		int	i )

inherited

Set the ith element of d_vars to a variable object.

Note: This method only sets the ith element to a BaseType object. The user should be responsible to release or allocate the resource properly. Use this method cautionally.

Parameters

bt	A pointer to the variable that is assigned to the ith element.
i	The index of the variable to be set.

Definition at line 301 of file Constructor.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 390 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 170 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 513 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

The	AttrTable 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::Byte, libdap::D4Enum, libdap::D4Group, libdap::D4Opaque, libdap::Int64, libdap::Int8, libdap::Structure, and libdap::UInt64.

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

root	The root group that should hold this new variable. Add Group-level stuff here (e.g., D4Dimensions).
container	Add the new variable to this container.

Returns: A pointer to the transformed variable

Reimplemented from libdap::Constructor.

Definition at line 109 of file Grid.cc.

◆ type()

Type libdap::BaseType::type ( ) const

virtualinherited

Returns the type of the class instance.

Definition at line 329 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 335 of file BaseType.cc.

◆ val2buf()

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

inlineoverridevirtualinherited

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

val	A pointer to the data to be inserted into the class data buffer.
reuse	A boolean value, indicating whether the class internal data storage can be reused or not. If this argument is TRUE, the class buffer is assumed to be large enough to hold the incoming data, and it is 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 134 of file Constructor.h.

◆ var() [1/2]

BaseType * libdap::Constructor::var	(	const string &	n,
		btp_stack &	s )

overridevirtualinherited

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

Deprecated

Deprecated: See comment in BaseType

Reimplemented from libdap::BaseType.

Definition at line 201 of file Constructor.cc.

◆ var() [2/2]

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

overridevirtualinherited

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

Reimplemented from libdap::BaseType.

Definition at line 191 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 269 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 273 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 276 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 280 of file Constructor.cc.

◆ variables()

const vector< BaseType * > & libdap::Constructor::variables ( ) const

inlineinherited

Get a const reference to the vector of BaseType pointers.

Note: Use this in range-based for loops to iterate over the variables.

Returns: A const reference to the vector of BaseType pointers.

Definition at line 110 of file Constructor.h.

◆ width()

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

overridevirtualinherited

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

constrained If true, return the size after applying a constraint.

Returns: The number of bytes used by the variable.

Deprecated: Use width_ll()

Reimplemented from libdap::BaseType.

Definition at line 156 of file Constructor.cc.

◆ width_ll()

int64_t libdap::Constructor::width_ll ( bool constrained = false ) const

overridevirtualinherited

Get the width of the Constructor's fields.

Parameters

constrained If true, return the constrained size

Returns: The number of bytes needed to store the values of this instance

Reimplemented from libdap::BaseType.

Definition at line 176 of file Constructor.cc.

Member Data Documentation

◆ d_vars

std::vector<BaseType *> libdap::Constructor::d_vars

protectedinherited

Definition at line 47 of file Constructor.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ btp_stack

◆ Map_citer

◆ Map_iter

◆ Map_riter

◆ Vars_citer

◆ Vars_iter

◆ Vars_riter

Constructor & Destructor Documentation

◆ Grid() [1/3]

◆ Grid() [2/3]

◆ Grid() [3/3]

◆ ~Grid()

Member Function Documentation

◆ add_map()

◆ add_var()

◆ add_var_nocopy()

◆ array_var()

◆ attributes()

◆ buf2val()

◆ check_semantics()

◆ clear_constraint()

◆ clear_local_data()

◆ components()

◆ compute_checksum()

◆ d4_ops()

◆ dataset()

◆ del_var() [1/2]

◆ del_var() [2/2]

◆ deserialize() [1/2]

◆ deserialize() [2/2]

◆ dump()

◆ element_count()

◆ FQN()

◆ get_ancestor()

◆ get_array()

◆ get_attr_table()

◆ get_map_iter()

◆ get_parent()

◆ get_var_index()

◆ get_vars_iter()

◆ intern_data() [1/2]

◆ intern_data() [2/2]

◆ is_constructor_type()

◆ is_dap2_only_type()

◆ is_dap4()

◆ is_dap4_projected()

◆ is_in_selection()

◆ is_linear()

◆ is_simple_type()

◆ is_vector_type()

◆ length()

◆ length_ll()

◆ m_duplicate() [1/2]

◆ m_duplicate() [2/2]

◆ m_exact_match()

◆ m_leaf_match()

◆ make_dropped_vars_attr_table()

◆ map_begin()

◆ map_end()

◆ map_rbegin()

◆ map_rend()

◆ name()

◆ operator=()

◆ ops()

◆ prepend_map()

◆ print_dap4()

◆ print_decl() [1/2]

◆ print_decl() [2/2]

◆ print_val() [1/2]

◆ print_val() [2/2]

◆ print_xml() [1/2]

◆ print_xml() [2/2]

◆ print_xml_writer()