#include <BaseType.h>
Inheritance diagram for BaseType:
Public Member Functions | |
virtual void | add_var (BaseType *bt, Part part=nil) |
Add a variable. | |
BaseType (const BaseType ©_from) | |
The BaseType copy constructor. | |
BaseType (const string &n="", const Type &t=dods_null_c, xdrproc_t xdr=NULL) | |
The BaseType constructor. | |
virtual bool | check_semantics (string &msg, bool all=false) |
Compare an object's current state with the semantics of its type. | |
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 () |
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_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. | |
BaseType & | operator= (const BaseType &rhs) |
virtual bool | ops (BaseType *b, int op, const string &dataset) |
Evaluate relational operators. | |
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_xml (FILE *out, string space=" ", bool constrained=false) |
virtual BaseType * | ptr_duplicate ()=0 |
virtual bool | read (const string &dataset) |
Read data into a local buffer. | |
virtual bool | read_p () |
Has this variable been read? | |
virtual bool | send_p () |
Should this variable be sent? | |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
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. | |
virtual bool | synthesized_p () |
virtual string | toString () |
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 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. | |
xdrproc_t | xdr_coder () |
Returns a function used to encode elements of an array. | |
virtual | ~BaseType () |
Abstract Methods | |
virtual unsigned int | buf2val (void **val)=0 |
Reads the class data. | |
virtual bool | deserialize (XDR *source, DDS *dds, bool reuse=false)=0 |
Receive data from the net. | |
virtual void | print_val (FILE *out, string space="", bool print_decl_p=true)=0 |
Prints the value of the variable. | |
virtual bool | serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, XDR *sink, bool ce_eval=true)=0 |
Move data to the net. | |
virtual unsigned int | val2buf (void *val, bool reuse=false)=0 |
Loads class data. | |
virtual unsigned int | width ()=0 |
Returns the size of the class instance data. | |
Protected Member Functions | |
void | _duplicate (const BaseType &bt) |
Perform a deep copy. |
These classes and their methods give a user the capacity to set up sophisticated data types. They do not provide sophisticated ways to access and use this data. On the server side, in many cases, the class instances will have no data in them at all until the serialize
function is called to send data to the client. On the client side, most DODS application programs will unpack the data promptly into whatever local data structure the programmer deems the most useful.
In order to use these classes on the server side of a DODS client/server connection, you must write a read
method for each of the data types you expect to encounter in the application. This function, whose purpose is to read data from a local source into the class instance data buffer, is called in serialize
, when the data is about to be sent to the client. The read
function may be called earlier, in the case of data subset requests (constraint expressions) whose evaluation requires it. (For example, the constraint expression ``a,b&b>c
'' requires that c
be read even though it will not be sent.)
For some data types, the read
function must be aware of the constraints to be returned. These cautions are outlined where they occur.
dods_byte Byte::value()
. Sure you have to downcast from BaseType to Byte in order to use it, but you have to figure out you have a Byte to use Byte::buf2val() anyway, so what's the big deal? Having a method that returns the value would simplify code that reads from data sets to extract meta data (like lat/lon corner points, et c.).
Definition at line 196 of file BaseType.h.
|
The BaseType constructor needs a name, a type, and the name of an XDR filter. The BaseType class exists to provide data to type classes that inherit from it. The constructors of those classes call the BaseType constructor; it is never called directly. Note that the constructor (as well as the copy constructor via _duplicate) open/initialize the (XDRS *)s XDRIN and XDROUT to reference sdtin and stdout. This means that writing to std{in,out} must work correctly, and probably means that is must be OK to mix calls to cout/cin with calls that write to std{out,in} (it is for g++ with libg++ at version 2.6 or greater).
Definition at line 101 of file BaseType.cc. |
|
Definition at line 107 of file BaseType.cc. References _duplicate(). |
Here is the call graph for this function:
|
Definition at line 112 of file BaseType.cc. References DBG. |
|
Perform a deep copy. Copies the values of bt into
Definition at line 64 of file BaseType.cc. References _name, _read_p, _send_p, _synthesized_p, _type, _xdr_coder, d_attr, d_in_selection, and d_parent. Referenced by BaseType(), and operator=(). |
|
Adds a variable to an instance of a constructor class, such as Array, Structure et cetera. This function is only used by those classes. For constructors with more than one variable, the variables appear in the same order in which they were added (i.e., the order in which add_var() was called). Since this method is only for use by Vectors and Constructors, the BaseType implementation throws InternalErr.
Reimplemented in Array, Grid, Sequence, Structure, and Vector. Definition at line 614 of file BaseType.cc. Referenced by DDXParser::ddx_end_element(). |
|
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
Implemented in Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Referenced by libdap::extract_double_value(), and libdap::extract_string_argument(). |
|
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.
Reimplemented in Array, Grid, Sequence, Structure, and Vector. Definition at line 851 of file BaseType.cc. References dods_null_c. Referenced by Vector::check_semantics(), Structure::check_semantics(), Sequence::check_semantics(), Grid::check_semantics(), and Array::check_semantics(). |
|
Receives data from the network connection identified by the This function is only used on the client side of the DODS client/server connection.
Implemented in Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Referenced by Vector::deserialize(), Sequence::deserialize(), and Grid::deserialize(). |
|
Displays the pointer value of this instance and then displays information about this base type.
Implements DapObj. Reimplemented in Array, Byte, Constructor, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Definition at line 158 of file BaseType.cc. References AttrTable::dump(), DapIndent::Indent(), type_name(), and DapIndent::UnIndent(). Referenced by Vector::dump(), UInt32::dump(), UInt16::dump(), Str::dump(), Int32::dump(), Int16::dump(), Grid::dump(), Float64::dump(), Float32::dump(), Constructor::dump(), and Byte::dump(). |
Here is the call graph for this function:
|
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.
Reimplemented in Grid, Sequence, Structure, and Vector. Definition at line 358 of file BaseType.cc. Referenced by Vector::element_count(). |
|
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 DDS::find_matching_container(), Constructor::find_matching_container(), Grid::print_xml(), Constructor::print_xml(), print_xml(), and Array::print_xml_core(). |
|
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.
Definition at line 550 of file BaseType.cc. Referenced by DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_two(), Sequence::transfer_data_for_leaf(), and Sequence::transfer_data_parent_part_two(). |
|
Definition at line 307 of file BaseType.cc. References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and type(). Referenced by DDXParser::ddx_end_element(), DDS::leaf_match(), DDS::transfer_attributes(), Constructor::transfer_attributes(), and Vector::var(). |
Here is the call graph for this function:
|
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.
Definition at line 505 of file BaseType.cc. |
|
Definition at line 250 of file BaseType.cc. References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and type(). Referenced by Grid::check_semantics(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::function_linear_scale(), Structure::is_linear(), Sequence::is_linear(), and libdap::set_array_using_double(). |
Here is the call graph for this function:
|
Definition at line 277 of file BaseType.cc. References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, dods_url_c, and type(). Referenced by DDXParser::ddx_end_element(), and libdap::function_linear_scale(). |
Here is the call graph for this function:
|
|
Definition at line 119 of file BaseType.cc. References _duplicate(). |
Here is the call graph for this function:
|
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.
Reimplemented in Byte, Float32, Float64, Int16, Int32, Str, UInt16, and UInt32. Definition at line 898 of file BaseType.cc. Referenced by Clause::value(). |
|
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]; Grid { ARRAY: Int32 sst[time = 404][lat = 180][lon = 360]; MAPS: Float64 time[time = 404]; Float64 lat[lat = 180]; Float64 lon[lon = 360]; } sst;
Reimplemented in Array, Constructor, and Grid. Definition at line 762 of file BaseType.cc. References id2www(), send_p(), and type_name(). Referenced by DODSFilter::functional_constraint(), DDS::print(), DDS::print_constrained(), Grid::print_decl(), Constructor::print_decl(), Array::print_decl(), UInt32::print_val(), UInt16::print_val(), Str::print_val(), Int32::print_val(), Int16::print_val(), Float64::print_val(), Float32::print_val(), and Byte::print_val(). |
Here is the call graph for this function:
|
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.
Implemented in Array, Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, and UInt32. Referenced by Sequence::deserialize(), Sequence::print_one_row(), Structure::print_val(), and Grid::print_val(). |
|
Write the XML representation of this variable. This method is used to build the DDX XML response.
Reimplemented in Array, Constructor, and Grid. Definition at line 791 of file BaseType.cc. References get_attr_table(), AttrTable::get_size(), id2xml(), AttrTable::print_xml(), send_p(), and type_name(). Referenced by Array::print_xml_core(). |
Here is the call graph for this function:
|
Clone this instance. Allocate a new instance and copy
Implemented in Array, Byte, Float32, Float64, Grid, Int16, Int32, PassiveArray, PassiveByte, PassiveFloat32, PassiveFloat64, PassiveInt16, PassiveInt32, PassiveStr, PassiveStructure, PassiveUInt16, PassiveUInt32, PassiveUrl, Sequence, Str, Structure, UInt16, UInt32, Url, and Vector. Referenced by Vector::_duplicate(), Vector::add_var(), Structure::add_var(), Sequence::add_var(), Grid::add_var(), DDS::add_var(), Vector::deserialize(), Sequence::deserialize(), libdap::function_geoarray(), libdap::function_geogrid(), and Vector::set_vec(). |
|
This method should be implemented for each of the data type classes (Byte, ..., Grid) when using the DAP class library to build a server. This method is only for DAP servers. The library provides a default definition here which throws an InternalErr exception unless the read_p property has been set. In that case it returns false, indicating that all the data have been read. The latter case can happen when building a constant value that needs to be passed to a function. The variable/constant is loaded with a value when it is created. When implementing a new DAP server, the Byte, ..., Grid data type classes are usually specialized. In each of those specializations read() should be defined to read values from the data source and store them in the object's local buffer. The read() method is called by other methods in this library. When writing read(), follow these rules:
Reimplemented in PassiveArray, PassiveByte, PassiveFloat32, PassiveFloat64, PassiveInt16, PassiveInt32, PassiveStr, PassiveStructure, PassiveUInt16, and PassiveUInt32. Definition at line 690 of file BaseType.cc. Referenced by GridGeoConstraint::apply_constraint_to_data(), ArrayGeoConstraint::apply_constraint_to_data(), libdap::function_geogrid(), libdap::function_grid(), libdap::function_linear_scale(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Sequence::read_row(), GeoConstraint::reorder_data_longitude_axis(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Structure::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), Grid::serialize(), Float64::serialize(), Float32::serialize(), Byte::serialize(), Structure::transfer_data(), and Sequence::transfer_data_parent_part_one(). |
|
|
Returns the state of the
Definition at line 453 of file BaseType.cc. Referenced by Grid::components(), Grid::print_decl(), Constructor::print_decl(), print_decl(), Array::print_decl(), Grid::print_val(), Grid::print_xml(), Constructor::print_xml(), print_xml(), Array::print_xml_core(), Grid::projection_yields_grid(), and Grid::serialize(). |
|
Sends the data from the indicated (local) dataset through the connection identified by the sink parameter. If the data is not already incorporated into the DDS object, read the data from the dataset. This function is only used on the server side of the client/server connection, and is generally only called from the DODSFilter::send() function. It has no BaseType implementation; each datatype child class supplies its own implementation.
Implemented in Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Referenced by DODSFilter::functional_constraint(), DODSFilter::send_blob(), Grid::serialize(), Sequence::serialize_leaf(), and Sequence::serialize_parent_part_two(). |
|
Set this variable's attribute table.
Definition at line 488 of file BaseType.cc. |
|
Set the in_selection property to state. This property indicates that the variable is used as a parameter to a constraint expression function or that it appears as an argument in a selection sub-expression. If set (true), implementations of the BaseType::read() method should read this variable.
Reimplemented in Grid, Sequence, and Structure. Definition at line 520 of file BaseType.cc. Referenced by Structure::set_in_selection(), Sequence::set_in_selection(), and Grid::set_in_selection(). |
|
Definition at line 188 of file BaseType.cc. References name(), and www2id(). Referenced by Vector::add_var(), and Array::print_xml_core(). |
Here is the call graph for this function:
|
Set the
Definition at line 533 of file BaseType.cc. Referenced by Vector::_duplicate(), Structure::_duplicate(), Vector::add_var(), Structure::add_var(), Sequence::add_var(), Grid::add_var(), and Vector::Vector(). |
|
Sets the value of the
Reimplemented in Grid, Sequence, Structure, and Vector. Definition at line 434 of file BaseType.cc. Referenced by PassiveUInt32::read(), PassiveUInt16::read(), PassiveStr::read(), PassiveInt32::read(), PassiveInt16::read(), PassiveFloat64::read(), PassiveFloat32::read(), PassiveByte::read(), Vector::set_read_p(), Structure::set_read_p(), Sequence::set_read_p(), Grid::set_read_p(), UInt32::set_value(), UInt16::set_value(), Str::set_value(), Int32::set_value(), Int16::set_value(), Float64::set_value(), Float32::set_value(), Byte::set_value(), and Clause::value(). |
Here is the call graph for this function:
|
Sets the value of the
Reimplemented in Grid, Sequence, Structure, and Vector. Definition at line 466 of file BaseType.cc. References DBG. Referenced by DDS::mark(), DDS::mark_all(), Vector::set_send_p(), Structure::set_send_p(), Sequence::set_send_p(), Grid::set_send_p(), and Clause::value(). |
|
Set the synthesized flag. Before setting this flag be sure to set the
Definition at line 378 of file BaseType.cc. |
|
Definition at line 203 of file BaseType.cc. Referenced by Url::Url(). |
|
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 367 of file BaseType.cc. |
|
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.
Reimplemented in Sequence. Definition at line 134 of file BaseType.cc. References type_name(). Referenced by Sequence::add_var(), GSEClause::GSEClause(), and Sequence::toString(). |
Here is the call graph for this function:
|
|
Definition at line 210 of file BaseType.cc. References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_grid_c, dods_int16_c, dods_int32_c, dods_null_c, dods_sequence_c, dods_str_c, dods_structure_c, dods_uint16_c, dods_uint32_c, and dods_url_c. Referenced by Vector::add_var(), Structure::check_semantics(), Sequence::check_semantics(), Grid::check_semantics(), Vector::deserialize(), dump(), Grid::print_decl(), Constructor::print_decl(), print_decl(), Constructor::print_xml(), print_xml(), and toString(). |
|
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.
Implemented in Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Referenced by libdap::function_linear_scale(), and Vector::var(). |
|
This version of var(...) searches for name and returns a pointer to the BaseType object if found. It uses the same search algorithm as BaseType::var(const string &, bool, btp_stack *) when exact_match is false. In addition to returning a pointer to the variable, it pushes onto s a BaseType pointer to each constructor type that ultimately contains name.
Reimplemented in Grid, Sequence, Structure, and Vector. Definition at line 579 of file BaseType.cc. References btp_stack. |
|
Returns a pointer to the contained variable in a composite class. The composite classes are those made up of aggregated simple data types. Array, Grid, and Structure are composite types, while Int and Float are simple types. This function is only used by composite classes. The BaseType implementation always returns null.
Several of the subclasses provide alternate access methods that make sense for that particular data type. For example, the Array class defines a
Reimplemented in Grid, Sequence, Structure, and Vector. Definition at line 557 of file BaseType.cc. References btp_stack. Referenced by DDS::exact_match(), Constructor::find_matching_container(), DDS::leaf_match(), and Vector::var(). |
|
Return the number of bytes that are required to hold the instance's value. In the case of simple types such as Int32, this is the size of one Int32 (four bytes). For a String or Url type, Implemented in Byte, Float32, Float64, Grid, Int16, Int32, Sequence, Str, Structure, UInt16, UInt32, and Vector. Referenced by Vector::deserialize(), GeoConstraint::reorder_data_longitude_axis(), Vector::serialize(), Vector::var(), Vector::width(), Structure::width(), Sequence::width(), and Grid::width(). |
|
The Note that this class data is only used for multiple element data types. The simple data types (Int, Float, and so on), are translated directly.
Definition at line 713 of file BaseType.cc. Referenced by Vector::deserialize(), and Vector::serialize(). |