#include <Sequence.h>
Inheritance diagram for Sequence:
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 *, Part part=nil) |
Adds a variable to the Sequence. | |
virtual unsigned int | buf2val (void **val) |
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) |
Deserialize (read from the network) the entire Sequence. | |
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 int | get_ending_row_number () |
Get the ending row number. | |
virtual BaseType * | get_parent () |
virtual int | get_row_stride () |
Get the row stride. | |
int | get_starting_row_number () |
Get the starting row number. | |
bool | get_unsent_data () |
Get the unsent data property. | |
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_leaf_sequence () |
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. | |
virtual int | length () |
string | name () const |
Returns the name of the class instance. | |
virtual int | number_of_rows () |
Sequence & | operator= (const Sequence &rhs) |
virtual bool | ops (BaseType *b, int op, const string &dataset) |
Evaluate relational operators. | |
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_one_row (FILE *out, int row, string space, bool print_row_num=false) |
virtual void | print_val (FILE *out, string space="", bool print_decl_p=true) |
Prints the value of the variable. | |
virtual void | print_val_by_rows (FILE *out, string space="", bool print_decl_p=true, bool print_row_numbers=true) |
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 | read_row (int row, const string &dataset, DDS &dds, ConstraintEvaluator &eval, bool ce_eval=true) |
void | reset_row_number () |
Rest the row number counter. | |
virtual BaseTypeRow * | row_value (size_t row) |
Get a whole row from the sequence. | |
virtual bool | send_p () |
Should this variable be sent? | |
Sequence (const Sequence &rhs) | |
The Sequence copy constructor. | |
Sequence (const string &n="") | |
The Sequence constructor. | |
virtual bool | serialize (const string &dataset, ConstraintEvaluator &eval, DDS &dds, XDR *sink, bool ce_eval=true) |
virtual void | set_attr_table (const AttrTable &at) |
virtual void | set_in_selection (bool state) |
virtual void | set_leaf_p (bool state) |
virtual void | set_leaf_sequence (int lvl=1) |
Mark the Sequence which holds the leaf elements. | |
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_row_number_constraint (int start, int stop, int stride=1) |
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. | |
void | set_unsent_data (bool usd) |
Set the unsent data property. | |
virtual void | set_value (SequenceValues &values) |
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) |
virtual SequenceValues | value () |
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 BaseType * | var_value (size_t row, size_t i) |
Get the BaseType pointer to the $i^{th}$ variable of row. | |
virtual BaseType * | var_value (size_t row, const string &name) |
Get the BaseType pointer to the named variable of a given row. | |
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 | ~Sequence () |
Protected Types | |
typedef vector< SequenceValues * > | sequence_values_stack_t |
Protected Member Functions | |
void | _duplicate (const BaseType &bt) |
Perform a deep copy. | |
void | _duplicate (const Constructor &s) |
virtual AttrTable * | find_matching_container (AttrTable::entry *source, BaseType **dest_variable) |
virtual bool | serialize_leaf (const string &dataset, DDS &dds, ConstraintEvaluator &eval, XDR *sink, bool ce_eval) |
virtual bool | serialize_parent_part_one (const string &dataset, DDS &dds, ConstraintEvaluator &eval, XDR *sink) |
virtual void | serialize_parent_part_two (const string &dataset, DDS &dds, ConstraintEvaluator &eval, XDR *sink) |
virtual void | transfer_data_for_leaf (const string &dataset, DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | transfer_data_parent_part_one (const string &dataset, DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | transfer_data_parent_part_two (const string &dataset, DDS &dds, ConstraintEvaluator &eval, sequence_values_stack_t &sequence_values_stack) |
virtual void | transfer_data_private (const string &dataset, ConstraintEvaluator &eval, DDS &dds, sequence_values_stack_t &sequence_values_stack) |
Protected Attributes | |
std::vector< BaseType * > | _vars |
Friends | |
class | SequenceTest |
Sequence { String name; Int32 age; } person;
This represents a Sequence of ``person'' records, each instance of which contains a name and an age:
Fred 34 Ralph 23 Andrea 29 ...
A Sequence can be arbitrarily long, which is to say that its length is not part of its declaration. A Sequence can contain other Sequences:
Sequence { String name; Int32 age; Sequence { String friend; } friend_list; } person;
This is still represented as a single table, but each row contains the elements of both the main Sequence and the nested one:
Fred 34 Norman Fred 34 Andrea Fred 34 Ralph Fred 34 Lisa Ralph 23 Norman Ralph 23 Andrea Ralph 23 Lisa Ralph 23 Marth Ralph 23 Throckmorton Ralph 23 Helga Ralph 23 Millicent Andrea 29 Ralph Andrea 29 Natasha Andrea 29 Norman ... .. ...
Internally, the Sequence is represented by a vector of vectors. The members of the outer vector are the members of the Sequence. This includes the nested Sequences, as in the above example.
NB: Note that in the past this class had a different behavior. It held only one row at a time and the deserialize(...) method had to be called from within a loop. This is no longer true. Now the deserailize(...) method should be called once and will read the entire sequence's values from the server. All the values are now stored in an instance of Sequence, not just a single row's.
Because the length of a Sequence is indeterminate, there are changes to the behavior of the functions to read this class of data. The read()
function for Sequence must be written so that successive calls return values for successive rows of the Sequence.
Similar to a C structure, you refer to members of Sequence elements with a ``.'' notation. For example, if the Sequence has a member Sequence called ``Tom'' and Tom has a member Float32 called ``shoe_size'', you can refer to Tom's shoe size as ``Tom.shoe_size''.
Definition at line 166 of file Sequence.h.
typedef vector<SequenceValues*> Sequence::sequence_values_stack_t [protected] |
Definition at line 212 of file Sequence.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.
Sequence::Sequence | ( | const string & | n = "" |
) |
The Sequence 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 145 of file Sequence.cc.
Referenced by ptr_duplicate().
Sequence::Sequence | ( | const Sequence & | rhs | ) |
Definition at line 153 of file Sequence.cc.
Sequence::~Sequence | ( | ) | [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] |
Remember that if you wish to add a member to a nested Sequence, you must use the add_var()
of that Sequence. This means that variable names need not be unique among a set of nested Sequences.
bt | A pointer to the DAP2 type variable to add to this Sequence. | |
part | defaults to nil |
Reimplemented from BaseType.
Definition at line 305 of file Sequence.cc.
References Constructor::_vars, DBG2, BaseType::ptr_duplicate(), BaseType::set_parent(), and BaseType::toString().
Here is the call graph for this function:
unsigned int Sequence::buf2val | ( | void ** | val | ) | [virtual] |
Never use this interface for Sequence! Use Sequence::var_value() or Sequence::row_value().
Implements BaseType.
Definition at line 1208 of file Sequence.cc.
bool Sequence::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.
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 1298 of file Sequence.cc.
References Constructor::_vars, BaseType::check_semantics(), BaseType::name(), BaseType::type_name(), and unique_names().
Here is the call graph for this function:
bool Sequence::deserialize | ( | XDR * | source, | |
DDS * | dds, | |||
bool | reuse = false | |||
) | [virtual] |
This method used to read a single row at a time. Now the entire sequence is read at once. The method used to return True to indicate that more data needed to be deserialized and False when the sequence was completely read. Now it simply returns false. This might seem odd, but making this method return true breaks existing software the least.
source | An XDR stream. | |
dds | A DataDDS from which to read. | |
reuse | Passed to child objects when they are deserialized. |
Error | if a sequence stream marker cannot be read. | |
InternalErr | if the dds param is not a DataDDS. |
Implements BaseType.
Definition at line 1078 of file Sequence.cc.
References Constructor::_vars, DBG2, DataDDS::get_protocol(), DataDDS::get_protocol_major(), DataDDS::get_protocol_minor(), and BaseType::name().
Here is the call graph for this function:
void Sequence::dump | ( | ostream & | strm | ) | const [virtual] |
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 1396 of file Sequence.cc.
References Constructor::dump(), DapIndent::Indent(), DapIndent::LMarg(), and DapIndent::UnIndent().
Here is the call graph for this function:
int Sequence::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.
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 223 of file Sequence.cc.
References Constructor::_vars.
Referenced by print_one_row().
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().
int Sequence::get_ending_row_number | ( | ) | [virtual] |
Return the ending row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1170 of file Sequence.cc.
Referenced by transfer_data_for_leaf(), and transfer_data_parent_part_one().
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(), serialize_leaf(), serialize_parent_part_two(), transfer_data_for_leaf(), and transfer_data_parent_part_two().
int Sequence::get_row_stride | ( | ) | [virtual] |
Return the row stride number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row stride is applied to the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1153 of file Sequence.cc.
Referenced by transfer_data_for_leaf(), and transfer_data_parent_part_one().
int Sequence::get_starting_row_number | ( | ) |
Return the starting row number if the sequence was constrained using row numbers (instead of, or in addition to, a relational constraint). If a relational constraint was also given, the row number corresponds to the row number of the sequence after applying the relational constraint.
If the bracket notation was not used to constrain this sequence, this method returns -1.
Definition at line 1137 of file Sequence.cc.
Referenced by transfer_data_for_leaf(), and transfer_data_parent_part_one().
bool Sequence::get_unsent_data | ( | ) | [inline] |
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 Sequence::is_leaf_sequence | ( | ) | [virtual] |
Definition at line 1323 of file Sequence.cc.
Referenced by serialize(), set_leaf_sequence(), and transfer_data_private().
bool Sequence::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.
Reimplemented from Constructor.
Definition at line 237 of file Sequence.cc.
References Constructor::_vars, dods_sequence_c, 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:
int Sequence::length | ( | ) | [virtual] |
Returns the number of elements in a Sequence object. Note that this is not the number of items in a row, but the number of rows in the complete sequence object. To be meaningful, this must be computed after constraint expresseion (CE) evaluation. The purpose of this function is to facilitate translations between Sequence objects and Array objects, particularly when the Sequence is too large to be transferred from the server to the client in its entirety.
This function, to be useful, must be specialized for the API and data format in use.
Definition at line 503 of file Sequence.cc.
string BaseType::name | ( | ) | const [inherited] |
Definition at line 181 of file BaseType.cc.
Referenced by Structure::_duplicate(), Vector::add_var(), Structure::check_semantics(), check_semantics(), Grid::check_semantics(), 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(), read_row(), serialize(), serialize_leaf(), serialize_parent_part_one(), serialize_parent_part_two(), set_leaf_sequence(), BaseType::set_name(), BaseType::set_read_p(), Constructor::transfer_attributes(), transfer_data(), transfer_data_for_leaf(), transfer_data_parent_part_one(), transfer_data_parent_part_two(), transfer_data_private(), rvalue::value_name(), Vector::var(), Structure::var(), var(), and Grid::var().
int Sequence::number_of_rows | ( | ) | [virtual] |
Definition at line 194 of file Sequence.cc.
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 Sequence::print_all_vals | ( | FILE * | out, | |
XDR * | src, | |||
DDS * | dds, | |||
string | space = "" , |
|||
bool | print_decl_p = true | |||
) | [virtual] |
Definition at line 1291 of file Sequence.cc.
References 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 print_val_by_rows().
Here is the call graph for this function:
void Sequence::print_one_row | ( | FILE * | out, | |
int | row, | |||
string | space, | |||
bool | print_row_num = false | |||
) | [virtual] |
Definition at line 1215 of file Sequence.cc.
References dods_sequence_c, element_count(), BaseType::print_val(), BaseType::type(), and var_value().
Referenced by print_val_by_rows().
Here is the call graph for this function:
void Sequence::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.
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 1278 of file Sequence.cc.
References print_val_by_rows().
Referenced by print_all_vals().
Here is the call graph for this function:
void Sequence::print_val_by_rows | ( | FILE * | out, | |
string | space = "" , |
|||
bool | print_decl_p = true , |
|||
bool | print_row_numbers = true | |||
) | [virtual] |
Definition at line 1253 of file Sequence.cc.
References number_of_rows(), Constructor::print_decl(), and print_one_row().
Referenced by print_val().
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 * Sequence::ptr_duplicate | ( | ) | [virtual] |
Clone this instance. Allocate a new instance and copy *this
into it. This method must perform a deep copy.
this
. Implements BaseType.
Definition at line 159 of file Sequence.cc.
References Sequence().
Here is the call graph for this function:
bool BaseType::read | ( | const string & | dataset | ) | [virtual, inherited] |
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 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(), 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(), and Structure::transfer_data().
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(), 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 Sequence::read_row | ( | int | row, | |
const string & | dataset, | |||
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
bool | ce_eval = true | |||
) | [virtual] |
Read row number row of the Sequence. The values of the row are obtained by calling the read() method of the sequence. The current row just read is stored in the Sequence instance along with its row number. If a selection expression has been supplied, rows are counted only if they satisfy that expression.
Note that we can only advance in a Sequence. It is not possible to back up and read a row numbered lower than the current row. If you need that you will need to replace the serialize() method with one of your own.
Used on the server side.
row | The row number to read. | |
dataset | A string, often a file name, used to refer to t he dataset. | |
dds | A reference to the DDS for this dataset. | |
eval | Use this as the constraint expression evaluator. | |
ce_eval | If True, evaluate any CE, otherwise do not. |
Definition at line 570 of file Sequence.cc.
References DBG2, ConstraintEvaluator::eval_selection(), BaseType::name(), BaseType::read(), BaseType::read_p(), set_read_p(), DDS::timeout_off(), and DDS::timeout_on().
Referenced by serialize_leaf(), serialize_parent_part_one(), transfer_data_for_leaf(), and transfer_data_parent_part_one().
Here is the call graph for this function:
void Sequence::reset_row_number | ( | ) |
When reading a nested sequence, use this method to reset the internal row number counter. This is necessary so that the second, ... instances of the inner/nested sequence will start off reading row zero.
Definition at line 519 of file Sequence.cc.
Referenced by transfer_data_parent_part_one().
BaseTypeRow * Sequence::row_value | ( | size_t | row | ) | [virtual] |
row | Get row number row from the sequence. |
Definition at line 404 of file Sequence.cc.
Referenced by var_value().
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 Sequence::serialize | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds, | |||
XDR * | sink, | |||
bool | ce_eval = true | |||
) | [virtual] |
Serialize a Sequence.
Leaf Sequences must be marked as such (see DDS::tag_nested_sequence()), as must the top most Sequence.
How the code works. Methods called for various functions are named in brackets:
Dataset { Sequence { Int x; Int y; } flat; } case_1;
Serialize it by reading successive rows and sending all of those that satisfy the CE. Before each row, send a start of instance (SOI) marker. Once all rows have been sent, send an End of Sequence (EOS) marker.[serialize_leaf].
Dataset { Sequence { Int t; Sequence { Int z; } inner; } outer; } case_2;
Serialize by reading the first row of outer and storing the values. Do not evaluate the CE [serialize_parent_part_one]. Call serialize() for inner and read each row for it, evaluating the CE for each row that is read. After the first row of inner is read and satisfies the CE, write out the SOI marker and values for outer [serialize_parent_part_two], then write the SOI and values for the first row of inner. Continue to read and send rows of inner until the last row has been read. Send EOS for inner [serialize_leaf]. Now read the next row of outer and repeat. Once outer\ is completely read, send its EOS marker.
Notes:
Implements BaseType.
Definition at line 685 of file Sequence.cc.
References DBG2, is_leaf_sequence(), BaseType::name(), serialize_leaf(), and serialize_parent_part_one().
Here is the call graph for this function:
bool Sequence::serialize_leaf | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
XDR * | sink, | |||
bool | ce_eval | |||
) | [protected, virtual] |
Definition at line 801 of file Sequence.cc.
References Constructor::_vars, DBG, dods_sequence_c, BaseType::get_parent(), BaseType::name(), read_row(), set_read_p(), and BaseType::type().
Referenced by serialize().
Here is the call graph for this function:
bool Sequence::serialize_parent_part_one | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
XDR * | sink | |||
) | [protected, virtual] |
Definition at line 702 of file Sequence.cc.
References Constructor::_vars, DBG, DBG2, dods_sequence_c, BaseType::name(), read_row(), and set_read_p().
Referenced by serialize().
Here is the call graph for this function:
void Sequence::serialize_parent_part_two | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
XDR * | sink | |||
) | [protected, virtual] |
Definition at line 768 of file Sequence.cc.
References Constructor::_vars, DBG, dods_sequence_c, BaseType::get_parent(), BaseType::name(), and BaseType::type().
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 Sequence::set_in_selection | ( | bool | state | ) | [virtual] |
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.
state | Set the in_selection property to this state. |
BaseType::is_in_selection() for more information.
Reimplemented from BaseType.
Definition at line 286 of file Sequence.cc.
References Constructor::_vars, and BaseType::set_in_selection().
Here is the call graph for this function:
void Sequence::set_leaf_p | ( | bool | state | ) | [virtual] |
void Sequence::set_leaf_sequence | ( | int | lvl = 1 |
) | [virtual] |
In a nested Sequence, the Sequence which holds the leaf elements is special because it during the serialization of this Sequence's data that constraint Expressions must be evaluated. If CEs are evaluated at the upper levels, then valid data may not be sent because it was effectlively hidden from the serialization and evaluation code (see the documentatin for the serialize_leaf() method).
The notion of the leaf Sequence needs to be modified to mean the lowest level of a Sequence where data are to be sent. Suppose there's a two level Sequence, but that only fields from the top level are to be sent. Then that top level is also the leaf Sequence and should be marked as such. If the lower level is marked as a leaf Sequence, then no values will ever be sent since the send_p property will always be false for each field and it's the call to serialize_leaf() that actually triggers transmission of values (because it's not until the code makes it into serialize_leaf() that it knows there are values to be sent.
lvl | The current level of the Sequence. a lvl of 1 indicates the topmost Sequence. The default value is 1. |
Definition at line 1353 of file Sequence.cc.
References Constructor::_vars, DBG2, dods_sequence_c, dods_structure_c, is_leaf_sequence(), BaseType::name(), and set_leaf_p().
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(), add_var(), Grid::add_var(), and Vector::Vector().
void Sequence::set_read_p | ( | bool | state | ) | [virtual] |
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 276 of file Sequence.cc.
References Constructor::_vars, and BaseType::set_read_p().
Referenced by read_row(), serialize_leaf(), serialize_parent_part_one(), transfer_data_for_leaf(), and transfer_data_parent_part_one().
Here is the call graph for this function:
void Sequence::set_row_number_constraint | ( | int | start, | |
int | stop, | |||
int | stride = 1 | |||
) | [virtual] |
Set the start, stop and stride for a row-number type constraint. This should be used only when the sequence is constrained using the bracket notation (which supplies start, stride and stop information). If omitted, the stride defaults to 1.
start | The starting row number. The first row is row zero. | |
stop | The eding row number. The 20th row is row 19. | |
stride | The stride. A stride of two skips every other row. |
Definition at line 1184 of file Sequence.cc.
References malformed_expr.
void Sequence::set_send_p | ( | bool | state | ) | [virtual] |
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 266 of file Sequence.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] |
void Sequence::set_unsent_data | ( | bool | usd | ) | [inline] |
void Sequence::set_value | ( | SequenceValues & | values | ) | [virtual] |
Set value of this Sequence. This does not perform a deep copy, so data should be allocated on the heap and freed only when the Sequence dtor is called.
values | Set the value of this Sequence. |
Definition at line 418 of file Sequence.cc.
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 Sequence::toString | ( | ) | [virtual] |
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 from BaseType.
Definition at line 207 of file Sequence.cc.
References Constructor::_vars, and BaseType::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 Sequence::transfer_data | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds | |||
) | [virtual] |
This method is used to evaluate a constraint and based on those results load the Sequence variable with data. This simulates having a server call the serialize() method and a client call the deserialize() method without the overhead of any IPC. Use this method on the server-side to 'load the d_values field with data' so that other code and work with those data.
The somewhat odd algorithm used by serialize() is largely copied here, so comments about logic in serialize() and the related methods apply here as well.
Only call this method for top-most Sequences. Never call it for Sequences which have a parent (directly or indirectly) variable that is a Sequence.
dataset | The name of the data set | |
eval | Use this contraint evaluator | |
dds | This DDS holds the variables for the data source |
Definition at line 890 of file Sequence.cc.
References DBG, BaseType::name(), and transfer_data_private().
Here is the call graph for this function:
void Sequence::transfer_data_for_leaf | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
sequence_values_stack_t & | sequence_values_stack | |||
) | [protected, virtual] |
Definition at line 921 of file Sequence.cc.
References DBG, dods_sequence_c, get_ending_row_number(), BaseType::get_parent(), get_row_stride(), get_starting_row_number(), BaseType::name(), read_row(), set_read_p(), BaseType::type(), Constructor::var_begin(), and Constructor::var_end().
Referenced by transfer_data_private().
Here is the call graph for this function:
void Sequence::transfer_data_parent_part_one | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
sequence_values_stack_t & | sequence_values_stack | |||
) | [protected, virtual] |
Definition at line 964 of file Sequence.cc.
References DBG, dods_sequence_c, dods_structure_c, get_ending_row_number(), get_row_stride(), get_starting_row_number(), BaseType::name(), read_row(), reset_row_number(), set_read_p(), Constructor::var_begin(), and Constructor::var_end().
Referenced by transfer_data_private().
Here is the call graph for this function:
void Sequence::transfer_data_parent_part_two | ( | const string & | dataset, | |
DDS & | dds, | |||
ConstraintEvaluator & | eval, | |||
sequence_values_stack_t & | sequence_values_stack | |||
) | [protected, virtual] |
Definition at line 1021 of file Sequence.cc.
References DBG, dods_sequence_c, BaseType::get_parent(), get_unsent_data(), BaseType::name(), set_unsent_data(), BaseType::type(), Constructor::var_begin(), and Constructor::var_end().
Here is the call graph for this function:
void Sequence::transfer_data_private | ( | const string & | dataset, | |
ConstraintEvaluator & | eval, | |||
DDS & | dds, | |||
sequence_values_stack_t & | sequence_values_stack | |||
) | [protected, virtual] |
Definition at line 905 of file Sequence.cc.
References DBG, is_leaf_sequence(), BaseType::name(), transfer_data_for_leaf(), and transfer_data_parent_part_one().
Referenced by transfer_data().
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(), print_one_row(), PassiveArray::read(), Vector::serialize(), serialize_leaf(), serialize_parent_part_two(), libdap::set_array_using_double(), Vector::set_value(), PassiveArray::set_value(), Vector::set_vec(), transfer_data_for_leaf(), 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(), 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 Sequence::val2buf | ( | void * | val, | |
bool | reuse = false | |||
) | [virtual] |
Never use this interface for Sequence! To add data to the members of a Sequence, use BaseTypeRow variables and operate on them individually.
Implements BaseType.
Definition at line 1197 of file Sequence.cc.
SequenceValues Sequence::value | ( | ) | [virtual] |
Get the value for this sequence.
Definition at line 426 of file Sequence.cc.
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 from BaseType.
Definition at line 326 of file Sequence.cc.
References BaseType::name(), and www2id().
Here is the call graph for this function:
BaseType * Sequence::var | ( | const string & | name, | |
bool | exact_match = true , |
|||
btp_stack * | s = 0 | |||
) | [virtual] |
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 338 of file Sequence.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(), transfer_data_for_leaf(), transfer_data_parent_part_one(), and 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(), transfer_data_for_leaf(), transfer_data_parent_part_one(), and 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.
BaseType * Sequence::var_value | ( | size_t | row, | |
size_t | i | |||
) | [virtual] |
row | Read from row in the sequence. | |
i | Return the $i^{th}$ variable from row. |
Definition at line 460 of file Sequence.cc.
References row_value().
Here is the call graph for this function:
BaseType * Sequence::var_value | ( | size_t | row, | |
const string & | name | |||
) | [virtual] |
row | Read from row in the sequence. | |
name | Return name from row. |
Definition at line 437 of file Sequence.cc.
References row_value().
Referenced by print_one_row().
Here is the call graph for this function:
unsigned int Sequence::width | ( | ) | [virtual] |
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 473 of file Sequence.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().
friend class SequenceTest [friend] |
Definition at line 208 of file Sequence.h.
std::vector<BaseType *> Constructor::_vars [protected, inherited] |
Definition at line 44 of file Constructor.h.
Referenced by Structure::_duplicate(), Structure::add_var(), add_var(), Structure::check_semantics(), check_semantics(), Structure::deserialize(), deserialize(), Constructor::dump(), Structure::element_count(), element_count(), Constructor::get_var_index(), Constructor::get_vars_iter(), Structure::is_linear(), is_linear(), Constructor::print_decl(), Structure::print_val(), PassiveStructure::read(), Structure::serialize(), serialize_leaf(), serialize_parent_part_one(), serialize_parent_part_two(), Structure::set_in_selection(), set_in_selection(), set_leaf_sequence(), Structure::set_read_p(), set_read_p(), Structure::set_send_p(), set_send_p(), toString(), Structure::transfer_data(), Constructor::var_begin(), Constructor::var_end(), Constructor::var_rbegin(), Constructor::var_rend(), Structure::width(), width(), ~Sequence(), and Structure::~Structure().