libdap::Structure Class Reference

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

#include <Structure.h>

Inheritance diagram for libdap::Structure:

Collaboration diagram for libdap::Structure:

List of all members.

Public Types

typedef stack< BaseType * > btp_stack

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

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

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

Public Member Functions

virtual void add_var (BaseType *bt, Part part=nil)

virtual unsigned int buf2val (void **val)

Never call this.

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

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

virtual bool deserialize (UnMarshaller &um, DDS *dds, bool reuse=false)

Receive data from the net.

virtual void dump (ostream &strm) const

dumps information about this object

virtual int element_count (bool leaves=false)

Count the members of constructor types.

virtual AttrTable & get_attr_table ()

virtual BaseType * get_parent ()

BaseType * get_var_index (int i)

Vars_iter get_vars_iter (int i)

virtual void intern_data (const string &dataset, ConstraintEvaluator &eval, DDS &dds)

virtual bool is_constructor_type ()

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

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

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

virtual bool is_vector_type ()

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

string name () const

Returns the name of the class instance.

Structure & operator= (const Structure &rhs)

virtual bool ops (BaseType *b, int op, const string &dataset)

Evaluate relational operators.

virtual void print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)

Print an ASCII representation of the variable structure.

virtual void print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)

Print an ASCII representation of the variable structure.

virtual void print_val (ostream &out, string space="", bool print_decl_p=true)

Prints the value of the variable.

virtual void print_val (FILE *out, string space="", bool print_decl_p=true)

Prints the value of the variable.

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

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

virtual BaseType * ptr_duplicate ()

virtual bool read (const string &dataset)

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

virtual bool read_p ()

Has this variable been read?

virtual bool send_p ()

Should this variable be sent?

virtual bool serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)

Move data to the net.

virtual void set_attr_table (const AttrTable &at)

virtual void set_in_selection (bool state)

Set the in_selection property.

virtual void set_leaf_sequence (int level=1)

Traverse Structure, set Sequence leaf nodes.

virtual void set_name (const string &n)

Sets the name of the class instance.

virtual void set_parent (BaseType *parent)

virtual void set_read_p (bool state)

Sets the value of the read_p property.

virtual void set_send_p (bool state)

virtual void set_synthesized_p (bool state)

void set_type (const Type &t)

Sets the type of the class instance.

Structure (const Structure &rhs)

Structure (const string &n="")

virtual bool synthesized_p ()

virtual string toString ()

virtual void transfer_attributes (AttrTable::entry *entry)

Type type () const

Returns the type of the class instance.

string type_name () const

Returns the type of the class instance as a string.

virtual unsigned int val2buf (void *val, bool reuse=false)

Never call this.

virtual BaseType * var (const string &name, btp_stack &s)

virtual BaseType * var (const string &name="", bool exact_match=true, btp_stack *s=0)

Returns a pointer to a member of a constructor class.

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

virtual BaseType * var (const string &name, bool exact_match=true, btp_stack *s=0)

Vars_iter var_begin ()

Vars_iter var_end ()

Vars_riter var_rbegin ()

Vars_riter var_rend ()

virtual unsigned int width ()

Returns the size of the class instance data.

virtual ~Structure ()

Protected Member Functions

void _duplicate (const BaseType &bt)

Perform a deep copy.

void _duplicate (const Constructor &s)

void _duplicate (const Structure &s)

virtual AttrTable * find_matching_container (AttrTable::entry *source, BaseType **dest_variable)

Protected Attributes

std::vector< BaseType * > _vars

Detailed Description

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

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

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

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

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

Todo:: Refactor with Sequence moving methods up into Constructor.

Definition at line 102 of file Structure.h.

Member Typedef Documentation

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

Definition at line 211 of file BaseType.h.

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

Definition at line 54 of file Constructor.h.

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

Definition at line 55 of file Constructor.h.

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

Definition at line 56 of file Constructor.h.

Constructor & Destructor Documentation

libdap::Structure::Structure ( const string & n = "" )

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

Parameters:

n

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

Definition at line 77 of file Structure.cc.

Referenced by ptr_duplicate().

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

The Structure copy constructor.

Definition at line 81 of file Structure.cc.

References _duplicate().

Here is the call graph for this function:

libdap::Structure::~Structure ( ) [virtual]

Definition at line 86 of file Structure.cc.

References libdap::Constructor::_vars.

Member Function Documentation

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

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

References libdap::BaseType::_name, libdap::BaseType::_read_p, libdap::BaseType::_send_p, libdap::BaseType::_synthesized_p, libdap::BaseType::_type, libdap::BaseType::d_attr, libdap::BaseType::d_in_selection, and libdap::BaseType::d_parent.

Referenced by libdap::BaseType::BaseType(), and libdap::BaseType::operator=().

void libdap::Constructor::_duplicate ( const Constructor & s ) [protected, inherited]

Definition at line 57 of file Constructor.cc.

Referenced by libdap::Constructor::operator=().

void libdap::Structure::_duplicate ( const Structure & s ) [protected]

Definition at line 51 of file Structure.cc.

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

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

Here is the call graph for this function:

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

Adds an element to a Structure.

Parameters:

	bt	A pointer to the DAP2 type variable to add to this Structure.
	part	Not used by this class, defaults to nil

Reimplemented from libdap::BaseType.

Definition at line 193 of file Structure.cc.

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

Here is the call graph for this function:

unsigned int libdap::Structure::buf2val ( void ** val ) [virtual]

See also:: val2buf()

Returns:: Returns the size of the structure.

Implements libdap::BaseType.

Definition at line 313 of file Structure.cc.

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

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

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

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

Returns:: Returns FALSE when the current state violates some aspect of the type semantics, TRUE otherwise.

Parameters:

	msg	A returned string, containing a message indicating the source of any problem.
	all	For complex constructor types (Grid, Sequence, Structure), this flag indicates whether to check the semantics of the member variables, too.

See also:: DDS::check_semantics

Reimplemented from libdap::BaseType.

Definition at line 450 of file Structure.cc.

References libdap::Constructor::_vars, libdap::BaseType::check_semantics(), libdap::BaseType::name(), libdap::BaseType::type_name(), and libdap::unique_names().

Here is the call graph for this function:

bool libdap::Structure::deserialize	(	UnMarshaller &	um,
		DDS *	dds,
		bool	reuse = `false`
	)			`[virtual]`

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

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

Parameters:

	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

Implements libdap::BaseType.

Definition at line 285 of file Structure.cc.

References libdap::Constructor::_vars.

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

Displays the pointer value of this instance and information about this instance.

Parameters:

strm

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

Returns:: void

Reimplemented from libdap::Constructor.

Definition at line 483 of file Structure.cc.

References libdap::Constructor::dump(), libdap::DapIndent::Indent(), libdap::DapIndent::LMarg(), and libdap::DapIndent::UnIndent().

Here is the call graph for this function:

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

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

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

Returns:: Returns 1 for simple types. For compound members, the count depends on the leaves argument.

Parameters:

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

References libdap::Constructor::_vars.

AttrTable * libdap::Constructor::find_matching_container	(	AttrTable::entry *	source,
		BaseType **	dest_variable
	)			`[protected, virtual, inherited]`

Given an attribute container from a table, find or make a destination for its contents in the current constructor variable.

Definition at line 132 of file Constructor.cc.

References libdap::AttrTable::append_container(), libdap::Attr_container, DBG, libdap::dods_grid_c, libdap::AttrTable::find_container(), libdap::BaseType::get_attr_table(), libdap::BaseType::get_parent(), libdap::AttrTable::entry::name, libdap::BaseType::type(), libdap::AttrTable::entry::type, and libdap::BaseType::var().

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

Here is the call graph for this function:

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

Get this variable's AttrTable. It's generally a bad idea to return a reference to a contained object, but in this case it seems that building an interface inside BaseType is overkill.

Use the AttrTable methods to manipulate the table.

Definition at line 480 of file BaseType.cc.

Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::Grid::print_xml(), libdap::Constructor::print_xml(), libdap::BaseType::print_xml(), and libdap::Array::print_xml_core().

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

Return a pointer to the Constructor or Vector which holds (contains) this variable. If this variable is at the top level, this method returns null.

Returns:: A BaseType pointer to the variable's parent.

Definition at line 550 of file BaseType.cc.

Referenced by libdap::DDS::find_matching_container(), libdap::Constructor::find_matching_container(), libdap::function_linear_scale(), libdap::Sequence::intern_data_for_leaf(), libdap::Sequence::intern_data_parent_part_two(), libdap::Sequence::serialize_leaf(), and libdap::Sequence::serialize_parent_part_two().

BaseType * libdap::Constructor::get_var_index ( int i ) [inherited]

Return the BaseType pointer for the ith variable.

Parameters:

i

This index

Returns:: The corresponding BaseType*.

Definition at line 270 of file Constructor.cc.

References libdap::Constructor::_vars.

Constructor::Vars_iter libdap::Constructor::get_vars_iter ( int i ) [inherited]

Return the iterator for the ith variable.

Parameters:

i

the index

Returns:: The corresponding Vars_iter

Definition at line 261 of file Constructor.cc.

References libdap::Constructor::_vars.

void libdap::Structure::intern_data	(	const string &	dataset,
		ConstraintEvaluator &	eval,
		DDS &	dds
	)			`[virtual]`

Similar to using serialize() and deserialize() together in one object. Data are read as for serialize and those values are stored in the objects as deserialize() does but does not write and then read data to/from a stream.

This method is defined by the various data type classes. It calls the read() abstract method.

Parameters:

	dataset	The (local) name of dataset to be read.
	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.

Definition at line 247 of file Structure.cc.

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

Here is the call graph for this function:

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

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

Definition at line 306 of file BaseType.cc.

References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().

Referenced by libdap::DDXParser::ddx_end_element(), libdap::DDS::leaf_match(), libdap::DDS::transfer_attributes(), libdap::Constructor::transfer_attributes(), and libdap::Vector::var().

Here is the call graph for this function:

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

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

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

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

Todo:: Change the name to is_flattenable or something like that. 05/16/03 jhrg

Returns:: True if the instance can be printed as a single table of values, false otherwise.

Reimplemented from libdap::Constructor.

Definition at line 128 of file Structure.cc.

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

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

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

References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().

Referenced by libdap::Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), and libdap::set_array_using_double().

Here is the call graph for this function:

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

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

Definition at line 274 of file BaseType.cc.

References libdap::dods_array_c, libdap::dods_byte_c, libdap::dods_float32_c, libdap::dods_float64_c, libdap::dods_grid_c, libdap::dods_int16_c, libdap::dods_int32_c, libdap::dods_null_c, libdap::dods_sequence_c, libdap::dods_str_c, libdap::dods_structure_c, libdap::dods_uint16_c, libdap::dods_uint32_c, libdap::dods_url_c, and libdap::BaseType::type().

Referenced by libdap::DDXParser::ddx_end_element().

Here is the call graph for this function:

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

Definition at line 173 of file BaseType.cc.

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

Definition at line 101 of file Structure.cc.

References _duplicate().

Here is the call graph for this function:

bool libdap::BaseType::ops	(	BaseType *	b,
		int	op,
		const string &	dataset
	)			`[virtual, inherited]`

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`.
	dataset	The name of the dataset from which the instance's data has come (or is to come).

Returns:: The boolean value of the comparison.

Reimplemented in libdap::Byte, libdap::Float32, libdap::Float64, libdap::Int16, libdap::Int32, libdap::Str, libdap::UInt16, and libdap::UInt32.

Definition at line 979 of file BaseType.cc.

Referenced by libdap::Clause::value().

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

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

Reimplemented in libdap::Grid.

Definition at line 302 of file Constructor.cc.

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

Here is the call graph for this function:

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

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

Reimplemented in libdap::Grid.

Definition at line 277 of file Constructor.cc.

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

Referenced by print_val(), and libdap::Sequence::print_val_by_rows().

Here is the call graph for this function:

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

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

Parameters:

	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.

Implements libdap::BaseType.

Definition at line 430 of file Structure.cc.

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

Here is the call graph for this function:

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

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

Parameters:

	out	The output FILE 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.

Implements libdap::BaseType.

Definition at line 410 of file Structure.cc.

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

Here is the call graph for this function:

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

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

Reimplemented in libdap::Grid.

Definition at line 387 of file Constructor.cc.

References libdap::BaseType::get_attr_table(), libdap::id2xml(), libdap::BaseType::name(), libdap::AttrTable::print_xml(), libdap::BaseType::send_p(), libdap::BaseType::type_name(), libdap::Constructor::var_begin(),


Public Types
typedef stack< BaseType * >	btp_stack
typedef std::vector< BaseType * > ::const_iterator	Vars_citer
typedef std::vector< BaseType * > ::iterator	Vars_iter
typedef std::vector< BaseType * > ::reverse_iterator	Vars_riter
Public Member Functions
virtual void	add_var (BaseType *bt, Part part=nil)
virtual unsigned int	buf2val (void **val)
	Never call this.
virtual bool	check_semantics (string &msg, bool all=false)
	Compare an object's current state with the semantics of its type.
virtual bool	deserialize (UnMarshaller &um, DDS *dds, bool reuse=false)
	Receive data from the net.
virtual void	dump (ostream &strm) const
	dumps information about this object
virtual int	element_count (bool leaves=false)
	Count the members of constructor types.
virtual AttrTable &	get_attr_table ()
virtual BaseType *	get_parent ()
BaseType *	get_var_index (int i)
Vars_iter	get_vars_iter (int i)
virtual void	intern_data (const string &dataset, ConstraintEvaluator &eval, DDS &dds)
virtual bool	is_constructor_type ()
	Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable.
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 ()
	Returns true if the instance is a numeric, string or URL type variable.
virtual bool	is_vector_type ()
	Returns true if the instance is a vector (i.e., array) type variable.
string	name () const
	Returns the name of the class instance.
Structure &	operator= (const Structure &rhs)
virtual bool	ops (BaseType *b, int op, const string &dataset)
	Evaluate relational operators.
virtual void	print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
	Print an ASCII representation of the variable structure.
virtual void	print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
	Print an ASCII representation of the variable structure.
virtual void	print_val (ostream &out, string space="", bool print_decl_p=true)
	Prints the value of the variable.
virtual void	print_val (FILE *out, string space="", bool print_decl_p=true)
	Prints the value of the variable.
virtual void	print_xml (ostream &out, string space=" ", bool constrained=false)
virtual void	print_xml (FILE *out, string space=" ", bool constrained=false)
virtual BaseType *	ptr_duplicate ()
virtual bool	read (const string &dataset)
	simple implementation of reat that iterates through vars and calls read on them
virtual bool	read_p ()
	Has this variable been read?
virtual bool	send_p ()
	Should this variable be sent?
virtual bool	serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
	Move data to the net.
virtual void	set_attr_table (const AttrTable &at)
virtual void	set_in_selection (bool state)
	Set the in_selection property.
virtual void	set_leaf_sequence (int level=1)
	Traverse Structure, set Sequence leaf nodes.
virtual void	set_name (const string &n)
	Sets the name of the class instance.
virtual void	set_parent (BaseType *parent)
virtual void	set_read_p (bool state)
	Sets the value of the read_p property.
virtual void	set_send_p (bool state)
virtual void	set_synthesized_p (bool state)
void	set_type (const Type &t)
	Sets the type of the class instance.
	Structure (const Structure &rhs)
	Structure (const string &n="")
virtual bool	synthesized_p ()
virtual string	toString ()
virtual void	transfer_attributes (AttrTable::entry *entry)
Type	type () const
	Returns the type of the class instance.
string	type_name () const
	Returns the type of the class instance as a string.
virtual unsigned int	val2buf (void *val, bool reuse=false)
	Never call this.
virtual BaseType *	var (const string &name, btp_stack &s)
virtual BaseType *	var (const string &name="", bool exact_match=true, btp_stack *s=0)
	Returns a pointer to a member of a constructor class.
virtual BaseType *	var (const string &n, btp_stack &s)
virtual BaseType *	var (const string &name, bool exact_match=true, btp_stack *s=0)
Vars_iter	var_begin ()
Vars_iter	var_end ()
Vars_riter	var_rbegin ()
Vars_riter	var_rend ()
virtual unsigned int	width ()
	Returns the size of the class instance data.
virtual	~Structure ()
Protected Member Functions
void	_duplicate (const BaseType &bt)
	Perform a deep copy.
void	_duplicate (const Constructor &s)
void	_duplicate (const Structure &s)
virtual AttrTable *	find_matching_container (AttrTable::entry source, BaseType *dest_variable)
Protected Attributes
std::vector< BaseType * >	_vars