#include <PassiveStructure.h>
Inheritance diagram for PassiveStructure:
Public Types | |
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 (XDR *source, 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 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. | |
PassiveStructure & | operator= (const PassiveStructure &rhs) |
virtual bool | ops (BaseType *b, int op, const string &dataset) |
Evaluate relational operators. | |
PassiveStructure (const PassiveStructure ©_from) | |
PassiveStructure (const string &n="") | |
virtual void | print_all_vals (FILE *out, XDR *src, DDS *dds, string space="", bool print_decl_p=true) |
virtual void | print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) |
Print an ASCII representation of the variable structure. | |
virtual void | print_val (FILE *out, string space="", bool print_decl_p=true) |
Prints the value of the variable. | |
virtual void | print_xml (FILE *out, string space=" ", bool constrained=false) |
virtual BaseType * | ptr_duplicate () |
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 bool | serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, XDR *sink, 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. | |
virtual bool | synthesized_p () |
virtual string | toString () |
virtual void | transfer_attributes (AttrTable::entry *entry) |
virtual void | transfer_data (const string &dataset, ConstraintEvaluator &eval, DDS &dds) |
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 &n, 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. | |
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. | |
xdrproc_t | xdr_coder () |
Returns a function used to encode elements of an array. | |
virtual | ~PassiveStructure () |
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 |
Definition at line 48 of file PassiveStructure.h.
typedef std::vector<BaseType *>::const_iterator Constructor::Vars_citer [inherited] |
Definition at line 51 of file Constructor.h.
typedef std::vector<BaseType *>::iterator Constructor::Vars_iter [inherited] |
Definition at line 52 of file Constructor.h.
typedef std::vector<BaseType *>::reverse_iterator Constructor::Vars_riter [inherited] |
Definition at line 53 of file Constructor.h.
PassiveStructure::PassiveStructure | ( | const string & | n = "" |
) |
The PassiveStructure 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.
n | A string containing the name of the variable to be created. |
Definition at line 60 of file PassiveStructure.cc.
Referenced by ptr_duplicate().
PassiveStructure::PassiveStructure | ( | const PassiveStructure & | copy_from | ) |
Definition at line 63 of file PassiveStructure.cc.
PassiveStructure::~PassiveStructure | ( | ) | [virtual] |
void 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.
bt | The source object. |
Definition at line 64 of file BaseType.cc.
References BaseType::_name, BaseType::_read_p, BaseType::_send_p, BaseType::_synthesized_p, BaseType::_type, BaseType::_xdr_coder, BaseType::d_attr, BaseType::d_in_selection, and BaseType::d_parent.
Referenced by BaseType::BaseType(), and BaseType::operator=().
void Constructor::_duplicate | ( | const Constructor & | s | ) | [protected, inherited] |
void Structure::_duplicate | ( | const Structure & | s | ) | [protected, inherited] |
Definition at line 51 of file Structure.cc.
References Constructor::_vars, DBG, BaseType::name(), and BaseType::set_parent().
Referenced by Structure::operator=(), operator=(), and Structure::Structure().
Here is the call graph for this function:
Adds an element to a Structure.
bt | A pointer to the DAP2 type variable to add to this Structure. | |
part | Not used by this class, defaults to nil |
Reimplemented from BaseType.
Definition at line 193 of file Structure.cc.
References Constructor::_vars, BaseType::ptr_duplicate(), and BaseType::set_parent().
Here is the call graph for this function:
unsigned int Structure::buf2val | ( | void ** | val | ) | [virtual, inherited] |
Implements BaseType.
Definition at line 304 of file Structure.cc.
bool Structure::check_semantics | ( | string & | msg, | |
bool | all = false | |||
) | [virtual, inherited] |
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.
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. |
Reimplemented from BaseType.
Definition at line 427 of file Structure.cc.
References Constructor::_vars, BaseType::check_semantics(), BaseType::name(), BaseType::type_name(), and unique_names().
Here is the call graph for this function:
bool Structure::deserialize | ( | XDR * | source, | |
DDS * | dds, | |||
bool | reuse = false | |||
) | [virtual, inherited] |
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.
source | A valid XDR pointer to the process connection to the net. This is generally created with a call to new_xdrstdio() . | |
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. |
Error | when a problem reading from the XDR stream is found. |
Implements BaseType.
Definition at line 276 of file Structure.cc.
References Constructor::_vars.
void Structure::dump | ( | ostream & | strm | ) | const [virtual, inherited] |
Displays the pointer value of this instance and information about this instance.
strm | C++ i/o stream to dump the information to |
Reimplemented from Constructor.
Definition at line 460 of file Structure.cc.
References Constructor::dump(), DapIndent::Indent(), DapIndent::LMarg(), and DapIndent::UnIndent().
Here is the call graph for this function:
int Structure::element_count | ( | bool | leaves = false |
) | [virtual, inherited] |
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.
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 BaseType.
Definition at line 114 of file Structure.cc.
References Constructor::_vars.
AttrTable * 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 130 of file Constructor.cc.
References AttrTable::append_container(), Attr_container, DBG, dods_grid_c, AttrTable::find_container(), BaseType::get_attr_table(), BaseType::get_parent(), AttrTable::entry::name, BaseType::type(), AttrTable::entry::type, and BaseType::var().
Referenced by Constructor::transfer_attributes().
Here is the call graph for this function:
AttrTable & 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 DDS::find_matching_container(), Constructor::find_matching_container(), Grid::print_xml(), Constructor::print_xml(), BaseType::print_xml(), and Array::print_xml_core().
BaseType * 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.
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().
BaseType * Constructor::get_var_index | ( | int | i | ) | [inherited] |
Return the BaseType pointer for the ith variable.
i | This index |
Definition at line 266 of file Constructor.cc.
References Constructor::_vars.
Constructor::Vars_iter Constructor::get_vars_iter | ( | int | i | ) | [inherited] |
Return the iterator for the ith variable.
i | the index |
Definition at line 257 of file Constructor.cc.
References Constructor::_vars.
bool BaseType::is_constructor_type | ( | ) | [virtual, inherited] |
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 BaseType::type().
Referenced by DDXParser::ddx_end_element(), DDS::transfer_attributes(), Constructor::transfer_attributes(), and Vector::var().
Here is the call graph for this function:
bool 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.
Definition at line 505 of file BaseType.cc.
bool Structure::is_linear | ( | ) | [virtual, inherited] |
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.
Reimplemented from Constructor.
Definition at line 128 of file Structure.cc.
References Constructor::_vars, and dods_structure_c.
bool BaseType::is_simple_type | ( | ) | [virtual, inherited] |
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 BaseType::type().
Referenced by 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 BaseType::is_vector_type | ( | ) | [virtual, inherited] |
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 BaseType::type().
Referenced by DDXParser::ddx_end_element().
Here is the call graph for this function:
string BaseType::name | ( | ) | const [inherited] |
Definition at line 181 of file BaseType.cc.
Referenced by Structure::_duplicate(), Vector::add_var(), Structure::check_semantics(), Sequence::check_semantics(), Grid::check_semantics(), Sequence::deserialize(), DDS::exact_match(), libdap::extract_double_array(), libdap::function_linear_scale(), GSEClause::get_map_name(), GridGeoConstraint::GridGeoConstraint(), GSEClause::GSEClause(), DDS::mark(), Grid::print_decl(), Constructor::print_decl(), Grid::print_xml(), Constructor::print_xml(), Array::print_xml_core(), Sequence::read_row(), Sequence::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_one(), Sequence::serialize_parent_part_two(), Sequence::set_leaf_sequence(), BaseType::set_name(), BaseType::set_read_p(), Constructor::transfer_attributes(), Sequence::transfer_data(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), Sequence::transfer_data_parent_part_two(), Sequence::transfer_data_private(), rvalue::value_name(), Vector::var(), Structure::var(), Sequence::var(), and Grid::var().
PassiveStructure & PassiveStructure::operator= | ( | const PassiveStructure & | rhs | ) |
Definition at line 78 of file PassiveStructure.cc.
References Structure::_duplicate().
Here is the call graph for this function:
bool 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.
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). |
Reimplemented in Byte, Float32, Float64, Int16, Int32, Str, UInt16, and UInt32.
Definition at line 898 of file BaseType.cc.
Referenced by Clause::value().
void Structure::print_all_vals | ( | FILE * | out, | |
XDR * | src, | |||
DDS * | dds, | |||
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual, inherited] |
Prints the Structure and all elements of any Sequences contained within.
Definition at line 421 of file Structure.cc.
References Structure::print_val().
Here is the call graph for this function:
void 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];
Grid { ARRAY: Int32 sst[time = 404][lat = 180][lon = 360]; MAPS: Float64 time[time = 404]; Float64 lat[lat = 180]; Float64 lon[lon = 360]; } sst;
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. |
DDS::CE
Reimplemented from BaseType.
Reimplemented in Grid.
Definition at line 273 of file Constructor.cc.
References Constructor::_vars, id2www(), BaseType::name(), BaseType::send_p(), and BaseType::type_name().
Referenced by Structure::print_val(), and Sequence::print_val_by_rows().
Here is the call graph for this function:
void Structure::print_val | ( | FILE * | out, | |
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual, inherited] |
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.
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 BaseType.
Definition at line 401 of file Structure.cc.
References Constructor::_vars, and Constructor::print_decl().
Referenced by Structure::print_all_vals().
Here is the call graph for this function:
void Constructor::print_xml | ( | FILE * | 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.
out | Destination. | |
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 BaseType.
Reimplemented in Grid.
Definition at line 314 of file Constructor.cc.
References BaseType::get_attr_table(), id2xml(), BaseType::name(), AttrTable::print_xml(), BaseType::send_p(), BaseType::type_name(), Constructor::var_begin(), and Constructor::var_end().
Here is the call graph for this function:
BaseType * PassiveStructure::ptr_duplicate | ( | ) | [virtual] |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
this
. Reimplemented from Structure.
Definition at line 67 of file PassiveStructure.cc.
References PassiveStructure().
Here is the call graph for this function:
bool PassiveStructure::read | ( | const string & | dataset | ) | [virtual] |
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:
read_p
property (using the read_p() method) and read values only if the value of read_p() is false. Once the read() method reads data and stores it in the instance, it must set the value of the read_p
property to true using set_read_p(). If your read() methods fail to do this data may not serialize correctly. unsent_data
property and row count in addition to the read_p
property (handle the read_p
property as describe above). For a Sequence to serialize correctly, once all data from the Sequence has been read, unsent_data
property must be set to false (use Sequence::set_unsent_data()). Also, at that time the row number counter must be reset (use Sequence::reset_row_counter()). Typically the correct time to set unsent_data
to false and reset the row counter is the time when Sequence::read() return false indicating that all the data for the Sequence have been read. Failure to handle these tasks will break serialization of nested Sequences. Note that when Sequence::read() returns with a result of true (indicating there is more data to send, the value of the unsent_data
property should be true.Also, if you server must handle nested sequences, be sure to read about subclassing set_read_p().
dataset | A string naming the 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. |
Reimplemented from BaseType.
Definition at line 91 of file PassiveStructure.cc.
References Constructor::_vars, and Structure::set_read_p().
Here is the call graph for this function:
bool BaseType::read_p | ( | ) | [virtual, inherited] |
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.
Definition at line 395 of file BaseType.cc.
Referenced by libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), PassiveUInt32::read(), PassiveUInt16::read(), PassiveStr::read(), PassiveInt32::read(), PassiveInt16::read(), PassiveFloat64::read(), PassiveFloat32::read(), PassiveByte::read(), PassiveArray::read(), Sequence::read_row(), Vector::serialize(), UInt32::serialize(), UInt16::serialize(), Structure::serialize(), Str::serialize(), Int32::serialize(), Int16::serialize(), Grid::serialize(), Float64::serialize(), Float32::serialize(), Byte::serialize(), and Structure::transfer_data().
bool BaseType::send_p | ( | ) | [virtual, inherited] |
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.
Definition at line 453 of file BaseType.cc.
Referenced by Grid::components(), Grid::print_decl(), Constructor::print_decl(), BaseType::print_decl(), Array::print_decl(), Grid::print_val(), Grid::print_xml(), Constructor::print_xml(), BaseType::print_xml(), Array::print_xml_core(), Grid::projection_yields_grid(), and Grid::serialize().
bool Structure::serialize | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds, | |||
XDR * | sink, | |||
bool | ce_eval = true | |||
) | [virtual, inherited] |
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.
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. | |
sink | A valid XDR pointer generally created with a call to new_xdrstdio() . This typically routes data to a TCP/IP socket. | |
ce_eval | A boolean value indicating whether to evaluate the DODS constraint expression that may accompany this dataset. The constraint expression is stored in dds. |
InternalErr. | ||
Error. |
Implements BaseType.
Definition at line 252 of file Structure.cc.
References Constructor::_vars, ConstraintEvaluator::eval_selection(), BaseType::read(), BaseType::read_p(), DDS::timeout_off(), and DDS::timeout_on().
Here is the call graph for this function:
void BaseType::set_attr_table | ( | const AttrTable & | at | ) | [virtual, inherited] |
Set this variable's attribute table.
at | Source of the attributes. |
Definition at line 488 of file BaseType.cc.
void Structure::set_in_selection | ( | bool | state | ) | [virtual, inherited] |
Set the in_selection property for this variable and all of its children.
state | Set the property value to state. |
Reimplemented from BaseType.
Definition at line 167 of file Structure.cc.
References Constructor::_vars, and BaseType::set_in_selection().
Here is the call graph for this function:
void Structure::set_leaf_sequence | ( | int | level = 1 |
) | [virtual, inherited] |
Definition at line 178 of file Structure.cc.
References dods_sequence_c, dods_structure_c, Constructor::var_begin(), and Constructor::var_end().
Here is the call graph for this function:
void BaseType::set_name | ( | const string & | n | ) | [virtual, inherited] |
Definition at line 188 of file BaseType.cc.
References BaseType::name(), and www2id().
Referenced by Vector::add_var(), and Array::print_xml_core().
Here is the call graph for this function:
void BaseType::set_parent | ( | BaseType * | parent | ) | [virtual, inherited] |
Set the parent
property for this variable. Only instances of Constructor or Vector should call this method.
parent | Pointer to the Constructor of Vector parent variable. |
InternalErr | thrown if called with anything other than a Constructor or Vector. |
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().
void Structure::set_read_p | ( | bool | state | ) | [virtual, inherited] |
Sets the value of the read_p
property. This indicates that the value(s) of this variable has/have been read. An implementation of the read() method would typically use this to set the read_p
property to true.
For synthesized variables, this method does nothing. Thus, if a synthesized variable is added to a Sequence, the Sequence can iteratively reset the read_p property without affecting the value of that property for the synthesized variable. That's important since a synthesized variable's value is calculated, not read.
state | Set the read_p property to this state. |
Reimplemented from BaseType.
Definition at line 152 of file Structure.cc.
References Constructor::_vars, and BaseType::set_read_p().
Referenced by read().
Here is the call graph for this function:
void Structure::set_send_p | ( | bool | state | ) | [virtual, inherited] |
Sets the value of the send_p
flag. This function is meant to be called from serialize()
. Data is ready to be sent when both the _send_p
and _read_p
flags are set to TRUE.
state | The logical state to set the send_p flag. |
Reimplemented from BaseType.
Definition at line 142 of file Structure.cc.
References Constructor::_vars, and BaseType::set_send_p().
Here is the call graph for this function:
void BaseType::set_synthesized_p | ( | bool | state | ) | [virtual, inherited] |
Set the synthesized flag. Before setting this flag be sure to set the read_p()
state. Once this flag is set you cannot alter the state of the read_p
flag!
Definition at line 378 of file BaseType.cc.
void BaseType::set_type | ( | const Type & | t | ) | [inherited] |
bool BaseType::synthesized_p | ( | ) | [virtual, inherited] |
Returns true if the variable is a synthesized variable. A synthesized variable is one that is added to the dataset by the server (usually with a `projection function'.
Definition at line 367 of file BaseType.cc.
string BaseType::toString | ( | ) | [virtual, inherited] |
Write out the object's internal fields in a string. To be used for debugging when regular inspection w/ddd or gdb isn't enough.
Reimplemented in Sequence.
Definition at line 134 of file BaseType.cc.
References BaseType::type_name().
Referenced by Sequence::add_var(), GSEClause::GSEClause(), and Sequence::toString().
Here is the call graph for this function:
void Constructor::transfer_attributes | ( | AttrTable::entry * | entry | ) | [virtual, inherited] |
Given an Attribute entry, scavenge attributes from it and load them into this object and the variables it contains. Assume that the caller has determined the table holds attributes pertinent to only this variable.
at | Get attribute information from this Attribute table. |
Definition at line 191 of file Constructor.cc.
References AttrTable::append_attr(), AttrTable::append_container(), AttrTable::attr_begin(), Attr_container, AttrTable::attr_end(), AttrTable::entry::attributes, DBG, Constructor::find_matching_container(), AttrTable::get_attr_vector(), AttrTable::get_name(), AttrTable::get_type(), BaseType::is_constructor_type(), BaseType::name(), and AttrTable::entry::type.
Here is the call graph for this function:
void Structure::transfer_data | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds | |||
) | [virtual, inherited] |
Definition at line 224 of file Structure.cc.
References Constructor::_vars, dods_sequence_c, dods_structure_c, BaseType::read(), and BaseType::read_p().
Here is the call graph for this function:
Type BaseType::type | ( | ) | const [inherited] |
Definition at line 196 of file BaseType.cc.
Referenced by Array::add_var(), Vector::buf2val(), Grid::check_semantics(), Vector::deserialize(), libdap::extract_double_array(), libdap::extract_double_value(), libdap::extract_string_argument(), DDS::find_matching_container(), Constructor::find_matching_container(), libdap::function_linear_scale(), BaseType::is_constructor_type(), BaseType::is_simple_type(), BaseType::is_vector_type(), UInt32::ops(), UInt16::ops(), Str::ops(), Int32::ops(), Int16::ops(), Float64::ops(), Float32::ops(), Byte::ops(), Sequence::print_one_row(), PassiveArray::read(), Vector::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_two(), libdap::set_array_using_double(), Vector::set_value(), PassiveArray::set_value(), Vector::set_vec(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_two(), Vector::val2buf(), Vector::value(), and Vector::var().
string BaseType::type_name | ( | ) | const [inherited] |
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(), BaseType::dump(), Grid::print_decl(), Constructor::print_decl(), BaseType::print_decl(), Constructor::print_xml(), BaseType::print_xml(), and BaseType::toString().
unsigned int Structure::val2buf | ( | void * | val, | |
bool | reuse = false | |||
) | [virtual, inherited] |
This method cannot be used to change values of a Structure since the values of a Constructor type must be set using methods in Constructor. See the Constructor::var_begin() and related methods.
Implements BaseType.
Definition at line 295 of file Structure.cc.
Reimplemented from BaseType.
Definition at line 322 of file Structure.cc.
References BaseType::name(), and www2id().
Here is the call graph for this function:
BaseType * Structure::var | ( | const string & | name, | |
bool | exact_match = true , |
|||
btp_stack * | s = 0 | |||
) | [virtual, inherited] |
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 *var(int i)
method that returns the ith entry in the Array data, and the Structure provides a *var(Vars_iter)
function using a pseudo-index to access the different members of the structure.
name | The name of the class member. Defaults to "" | |
exact_match | True if only interested in variables whose full names match n exactly. If false, returns the first variable whose name matches name. For example, if name is x and point.x is a variable, then var("x", false) would return a BaseType pointer to point.x . If exact_match was true then name would need to be "point.x" for var to return that pointer. This feature simplifies constraint expressions for datasets which have complex, nested, constructor variables. Defaults to true. | |
s | Record the path to name. Defaults to null, in which case it is not used. |
Reimplemented from BaseType.
Definition at line 310 of file Structure.cc.
References www2id().
Here is the call graph for this function:
Constructor::Vars_iter Constructor::var_begin | ( | ) | [inherited] |
Returns an iterator referencing the first structure element.
Definition at line 85 of file Constructor.cc.
References Constructor::_vars.
Referenced by DDXParser::ddx_end_document(), Constructor::print_xml(), Structure::set_leaf_sequence(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), and Sequence::transfer_data_parent_part_two().
Constructor::Vars_iter 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 233 of file Constructor.cc.
References Constructor::_vars.
Referenced by DDXParser::ddx_end_document(), Constructor::print_xml(), Structure::set_leaf_sequence(), Sequence::transfer_data_for_leaf(), Sequence::transfer_data_parent_part_one(), and Sequence::transfer_data_parent_part_two().
Constructor::Vars_riter Constructor::var_rbegin | ( | ) | [inherited] |
Return a reverse iterator that references the last element.
Definition at line 240 of file Constructor.cc.
References Constructor::_vars.
Constructor::Vars_riter Constructor::var_rend | ( | ) | [inherited] |
Return a reverse iterator that references a point 'before' the first element.
Definition at line 248 of file Constructor.cc.
References Constructor::_vars.
unsigned int Structure::width | ( | ) | [virtual, inherited] |
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, width()
returns the number of bytes needed for a String *
variable, not the bytes needed for all the characters, since that value cannot be determined from type information alone. For Structure, and other constructor types size() returns the number of bytes needed to store pointers to the C++ objects.
Implements BaseType.
Definition at line 212 of file Structure.cc.
References Constructor::_vars.
xdrproc_t BaseType::xdr_coder | ( | ) | [inherited] |
The xdr_coder
function (also "filter primitive") is used to encode and decode each element in a multiple element data structure. These functions are used to convert data to and from its local representation to the XDR representation, which is used to transmit and receive the data. See man xdr
for more information about the available XDR filter primitives.
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().
std::vector<BaseType *> Constructor::_vars [protected, inherited] |
Definition at line 44 of file Constructor.h.
Referenced by Structure::_duplicate(), Structure::add_var(), Sequence::add_var(), Structure::check_semantics(), Sequence::check_semantics(), Structure::deserialize(), Sequence::deserialize(), Constructor::dump(), Structure::element_count(), Sequence::element_count(), Constructor::get_var_index(), Constructor::get_vars_iter(), Structure::is_linear(), Sequence::is_linear(), Constructor::print_decl(), Structure::print_val(), read(), Structure::serialize(), Sequence::serialize_leaf(), Sequence::serialize_parent_part_one(), Sequence::serialize_parent_part_two(), Structure::set_in_selection(), Sequence::set_in_selection(), Sequence::set_leaf_sequence(), Structure::set_read_p(), Sequence::set_read_p(), Structure::set_send_p(), Sequence::set_send_p(), Sequence::toString(), Structure::transfer_data(), Constructor::var_begin(), Constructor::var_end(), Constructor::var_rbegin(), Constructor::var_rend(), Structure::width(), Sequence::width(), Sequence::~Sequence(), and Structure::~Structure().