OPeNDAP Reference Manual. Generated by Doxygen

Transcription

1 OPeNDAP Reference Manual Generated by Doxygen Fri Jul 19 23:58:

2

3 Contents 1 OPeNDAP Hierarchical Index OPeNDAP Class Hierarchy OPeNDAP Compound Index OPeNDAP Compound List OPeNDAP Class Documentation Array Class Reference AttrTable Class Reference BaseType Class Reference Byte Class Reference Clause Struct Reference Cmp Class Template Reference Connect Class Reference Connections Class Template Reference DAS Class Reference DataDDS Class Reference DDS Class Reference DODSFilter Class Reference Error Class Reference Float32 Class Reference Float64 Class Reference Grid Class Reference

4 ii CONTENTS 3.17 gse arg Struct Reference GSEClause Class Reference Gui Class Reference Int16 Class Reference Int32 Class Reference InternalErr Class Reference List Class Reference rvalue Class Reference Sequence Class Reference Str Class Reference StrCmp Class Template Reference Structure Class Reference SUCmp Class Template Reference UInt16 Class Reference UInt32 Class Reference Url Class Reference USCmp Class Template Reference Vector Class Reference

5 Chapter 1 OPeNDAP Hierarchical Index 1.1 OPeNDAP Class Hierarchy This inheritance list is sorted roughly, but not completely, alphabetically: HTStream AttrTable DAS AttrTableTest BaseType Byte Constructor Grid Sequence Structure Float Float Int Int Str Url UInt UInt Vector Array List ByteTest cgiutiltest Clause Cmp T1, T

6 2 OPeNDAP Hierarchical Index Connect Connections T DASTest DataDDSTest DDS DataDDS DDSTest DODSFilter DODSFilterTest Error InternalErr generalutiltest gse arg GSEClause Gui parser arg parserutiltest RCReader rvalue SequenceTest StrCmp T1, T SUCmp T1, UT TextTestResult Translation USCmp UT1, T value yy buffer state YYSTYPE

7 Chapter 2 OPeNDAP Compound Index 2.1 OPeNDAP Compound List Here are the classes, structs, unions and interfaces with brief descriptions: Array (A multidimensional array of identical data types) AttrTable (Contains the attributes for a dataset) BaseType (The basic data type for the DODS DAP types) Byte (Holds a single byte) Clause (Holds a fragment of a constraint expression) Cmp T1, T Connect (Holds information about the link from a DODS client to a dataset). 71 Connections T (Holds an ensemble of Connect objects) DAS (Hold attribute data for a DODS dataset) DataDDS (Holds a DODS DDS) DDS DODSFilter (Common functions for DODS server filter programs) Error (A class for error processing) Float32 (Holds a 32-bit floating point value) Float64 (Holds a 64-bit (double precision) floating point value) Grid (Holds the Grid data type) gse arg GSEClause Gui (Implements a graphic user interface for a DODS client) Int16 (Holds a 16-bit signed integer value) Int32 (Holds a 32-bit signed integer) InternalErr (A class for software fault reporting) List (Holds a list of other objects) rvalue Sequence (Holds a sequence)

8 4 OPeNDAP Compound Index Str (Holds character string data) StrCmp T1, T Structure (Holds a structure (aggregate) type) SUCmp T1, UT UInt16 (Holds an unisigned 16-bit integer) UInt32 (Holds a 32-bit unsigned integer) Url (Holds an internet address (URL)) USCmp UT1, T Vector (Holds a one-dimensional collection of DODS data types)

9 Chapter 3 OPeNDAP Class Documentation 3.1 Array Class Reference A multidimensional array of identical data types. #include Array.h Inheritance diagram for Array:: BaseType Vector Array Public Methods Array (const string &n=, BaseType Array constructor. v=0) Array (const Array &rhs) The Array copy constructor. virtual Array ()

10 6 OPeNDAP Class Documentation The Array destructor. Array & operator= (const Array &rhs) virtual BaseType ptr duplicate ()=0 virtual bool read (const string &dataset)=0 void update length (int size) Changes the size property of the array. void append dim (int size, string name= ) Add a dimension of a given size. void add constraint (Pix p, int start, int stride, int stop) Adds a dimension constraint to an Array. void reset constraint () Reset constraint to select entire array. void clear constraint () Clears the projection; add each projected dimension explicitly using add - constraint. Pix first dim () Return first dimension of array. void next dim (Pix &p) Return next array dimension. int dimension size (Pix p, bool constrained=false) Returns the size of the dimension. int dimension start (Pix p, bool constrained=false) Return the start index of a dimension. int dimension stop (Pix p, bool constrained=false) Return the stop index of the constraint. int dimension stride (Pix p, bool constrained=false) Returns the stride value of the constraint. string dimension name (Pix p) Returns the name of the specified dimension. unsigned int dimensions (bool constrained=false)

11 3.1 Array Class Reference 7 Return the total number of dimensions in the array. virtual void print decl (ostream &os, string space=, bool print semi=true, bool constraint info=false, bool constrained=false) Prints a DDS entry for the Array. virtual void print val (ostream &os, string space=, bool print decl p=true) Print the value given the current constraint. virtual bool check semantics (string &msg, bool all=false) Check semantic features of the Array. Protected Methods void duplicate (const Array &a) Detailed Description A multidimensional array of identical data types. This class is used to hold arrays of other DODS data. The elements of the array can be simple or compound data types. There is no limit on the number of dimensions an array can have, or on the size of each dimension. If desired, the user can give each dimension of an array a name. You can, for example, have a 360x180 array of temperatures, covering the whole globe with one-degree squares. In this case, you could name the first dimension Longitude and the second dimension Latitude. This can help prevent a great deal of confusion. The Array is used as part of the Grid class, where the dimension names are crucial to its structure. The dimension names correspond to Map vectors, holding the actual values for that column of the array. Each array dimension carries with it its own projection information. The projection inforamtion takes the form of three integers: the start, stop, and stride values. This is clearest with an example. Consider a one-dimensional array 10 elements long. If the start value of the dimension constraint is 3, then the constrained array appears to be seven elements long. If the stop value is changed to 7, then the array appears to be five elements long. If the stride is changed to two, the array will appear to be 3 elements long. Array constraints are written as: [start:stride:stop]. A = [ ] A[3::] = [ ]

12 8 OPeNDAP Class Documentation A[3::7] = [ ] A[3:2:7] = [4 6 8] A[0:3:9] = [ ] note DODS uses zero-based indexing. See also: Grid, List Definition at line 78 of file Array.h Constructor & Destructor Documentation Array::Array (const string & n =, BaseType v = 0) Array constructor. The Array constructor requires the name of the variable to be created, and the type of data the Array is to hold. The name may be omitted, which will create a nameless variable. The template pointer may also be omitted. Note that if the template pointer is omitted when the Array is created, it must be added (with add var()) before read() or deserialize() is called. n A string containing the name of the variable to be created. v A pointer to a variable of the type to be included in the Array. Definition at line 77 of file Array.cc Member Function Documentation void Array::add constraint (Pix p, int start, int stride, int stop) Adds a dimension constraint to an Array. Once a dimension has been created (see append dim()), it can be constrained. This will make the array appear to the rest of the world to be smaller than it is. This

13 3.1 Array Class Reference 9 functions sets the projection for a dimension, and marks that dimension as part of the current projection. A stride value = 0 or the array size is an error and causes add constraint to return FALSE. Similarly, start or stop values greater than the dimension size will cause a FALSE return value. p An index (of type Pix) pointing to the dimension in the list of dimensions. start The start index of the constraint. stride The stride value of the constraint. stop The stop index of the constraint. void; in case of failure it throws an exception. Definition at line 222 of file Array.cc. References update length void Array::append dim (int size, string name = ) Add a dimension of a given size. Given a size and a name, this function adds a dimension to the array. For example, if the Array is already 10 elements long, calling append dim with a size of 5 will transform the array into a 10x5 matrix. Calling it again with a size of 2 will create a 10x5x2 array, and so on. This sets Vector s length member as a side effect. size The size of the desired new row. name The name of the new dimension. This defaults to an empty string. Definition at line 121 of file Array.cc. References BaseType::name, and update length bool Array::check semantics (string & msg, bool all = false) [virtual] Check semantic features of the Array. This function checks semantic features of the Array. Currently, the only check specific to the Array is that there must be dimensions. The rest is inherited from BaseType::check semantics().

14 10 OPeNDAP Class Documentation A boolean value. FALSE means there was a problem. Reimplemented from Vector. Definition at line 607 of file Array.cc. References BaseType::check semantics void Array::clear constraint () Clears the projection; add each projected dimension explicitly using add - constraint. Tell the Array object to clear the constraint information about dimensions. Do this once before calling add constraint() for each new constraint expression. Only the dimensions explicitly selected using add constraint() will be sent. Definition at line 177 of file Array.cc. References Vector::set length string Array::dimension name (Pix p) Returns the name of the specified dimension. This function returns the name of the dimension indicated with p. Since this method is public, it is possible to call it before the Array object has been properly initialized. This will cause an exception. So don t do that. p The Pix index of the dimension. A pointer to a string containing the dimension name. Definition at line 456 of file Array.cc. References dimension name. Referenced by dimension name int Array::dimension size (Pix p, bool constrained = false) Returns the size of the dimension. Return the size of the array dimension referred to by p. If the dimension is constrained (indicated with the constrained argument), the constrained size is returned.

15 3.1 Array Class Reference 11 p The Pix index of the dimension. constrained If this parameter is TRUE, the function returns the constrained size of the array. If the dimension is not selected, the function returns zero. If it is FALSE, the function returns the dimension size whether or not the dimension is constrained. The default value is FALSE. An integer containing the size of the specified dimension. Definition at line 318 of file Array.cc. Referenced by Grid::check semantics, print val, and Grid::projection yields grid int Array::dimension start (Pix p, bool constrained = false) Return the start index of a dimension. Use this function to return the start index of an array dimension. If the array is constrained (indicated with the constrained argument), the start index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension stop() and dimension stride(). p The Pix index of the dimension. constrained If this parameter is TRUE, the function returns the start index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the start index whether or not the dimension is constrained. The desired start index. Definition at line 355 of file Array.cc. References dimension start. Referenced by dimension start, GSEClause::GSEClause, and Grid::projection yields - grid int Array::dimension stop (Pix p, bool constrained = false) Return the stop index of the constraint. Use this function to return the stop index of an array dimension. If the array is constrained (indicated with the constrained argument), the stop index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension start() and dimension stride().

16 12 OPeNDAP Class Documentation p The Pix index of the dimension. constrained If this parameter is TRUE, the function returns the stop index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stop index whether or not the dimension is constrained. The desired stop index. Definition at line 391 of file Array.cc. References dimension stop. Referenced by dimension stop, GSEClause::GSEClause, and Grid::projection yields - grid int Array::dimension stride (Pix p, bool constrained = false) Returns the stride value of the constraint. Use this function to return the stride value of an array dimension. If the array is constrained (indicated with the constrained argument), the stride value of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension stop() and dimension start(). p The Pix index of the dimension. constrained If this parameter is TRUE, the function returns the stride value only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stride value whether or not the dimension is constrained. The stride value requested, or zero, if constrained is TRUE and the dimension is not selected. Definition at line 428 of file Array.cc. References dimension stride. Referenced by dimension stride, and Grid::projection yields grid unsigned int Array::dimensions (bool constrained = false) Return the total number of dimensions in the array.

17 3.1 Array Class Reference 13 Return the total number of dimensions contained in the array. When constrained is TRUE, return the number of dimensions given the most recently evaluated constraint expression. constrained A boolean flag to indicate whether the array is constrained or not. By default, constrained is FALSE. Definition at line 288 of file Array.cc. References first dim, and next dim. Referenced by Grid::check semantics, and print val Pix Array::first dim () Return first dimension of array. Returns a pointer to the first dimension of the array. Use next dim() to return successive dimensions. A Pix object indicating the first array dimension. Definition at line 257 of file Array.cc. Referenced by Grid::check semantics, dimensions, GSEClause::GSEClause, print val, and Grid::projection yields grid void Array::next dim (Pix & p) Return next array dimension. Given a dimension index, increments it to point to the next dimension. first dim() to return the first dimensions. Use p A Pix object indicating the array dimension immediately before the desired one. A Pix object indicating the array dimension immediately after the one specified by p. Definition at line 272 of file Array.cc. Referenced by Grid::check semantics, dimensions, print val, and Grid::projection - yields grid.

18 14 OPeNDAP Class Documentation void Array::print decl (ostream & os, string space =, bool print semi = true, bool constraint info = false, bool constrained = false) [virtual] Prints a DDS entry for the Array. Prints a declaration for the Array. This is what appears in a DDS. If the Array is constrained, the declaration will allocate only enough space for the constrained values. os An output stream to prin on. space A string containing spaces to precede the declaration. print semi A boolean indicating whether to print a semi-colon after the declaration. (TRUE means print a semi-colon. ) constraint info A boolean value. See BaseType::print decl(). constrained This argument should be TRUE if the Array is constrained, and FALSE otherwise. Reimplemented from Vector. Definition at line 490 of file Array.cc. References BaseType::print decl, print decl, BaseType::print val, BaseType::send p, and Vector::var. Referenced by print decl, and print val void Array::print val (ostream & os, string space =, bool print decl p = true) [virtual] Print the value given the current constraint. Prints the value of the entire (constrained) array. os The output stream to print on. space The space to use in printing. print decl p A boolean value indicating whether you want the Array declaration to precede the Array value. Reimplemented from Vector. Definition at line 570 of file Array.cc. References dimension size, dimensions, first dim, next dim, and print decl.

19 3.1 Array Class Reference virtual bool Array::read (const string & dataset) [pure virtual] This function should read local data and fill in the data buffer. When reading the data, the read function should use the constraint and selection information available for each dimension of the array to decide how much of the array to read. Only the values to be transmitted with serialize() must be read. The implementation of this function is part of creating a new DODS server, and is left for the user. For other details, refer to the description of the read() function in the BaseType class. See also: BaseType::read Implements Vector void Array::reset constraint () Reset constraint to select entire array. Resets the dimension constraint information so that the entire array is selected. Definition at line 148 of file Array.cc. References Vector::set length, and update length void Array::update length (int size) Changes the size property of the array. Deprecated: Changes the size property of the array. If the array exists, it is augmented by a factor of size. This does not change the actual size of the array. Definition at line 51 of file Array.cc. References Vector::length, and Vector::set length. Referenced by add constraint, append dim, and reset constraint. The documentation for this class was generated from the following files: Array.h Array.cc

20 16 OPeNDAP Class Documentation 3.2 AttrTable Class Reference Contains the attributes for a dataset. #include AttrTable.h Inheritance diagram for AttrTable:: AttrTable DAS Public Methods unsigned int get size () const Get the number of entries in this attribute table. string get name () Get the name of this attribute table. AttrTable find container (const string &target) Find an attribute with a given name. Pix find (const string &target, AttrTable at) Find an attribute or container with a given name. void set name (const string &n) Set the name of this attribute table. unsigned int append attr (const string &name, const string &type, const string &value) throw (Error) Add an attribute to the table. unsigned int append attr (const char name, const char type, const char value) throw (Error) AttrTable append container (const string &name) throw (Error) Add a container to the attribute table.

21 3.2 AttrTable Class Reference 17 AttrTable append container (AttrTable at, const string &name) throw (Error) Add a container to the attribute table. void add container alias (const string &name, AttrTable Add an alias to a container held by this attribute table. src) throw (Error) void add value alias (AttrTable das, const string &name, const string &source) throw (Error) Add an alias to an attribute held by this attribute table. bool attr alias (const string &alias, AttrTable Adds an alias to the set of attr alias(). bool attr alias (const string &alias, const string &name) void del attr (const string &name, int i=-1) Deletes an attribute. at, const string &name) void print (ostream &os, string pad=, bool dereference=false) Prints an attribute table. AttrTable append container (const string &name) throw (Error) AttrTable append container (AttrTable at, const string &name) throw (Error) void add container alias (const string &name, AttrTable src) throw (Error) void add value alias (AttrTable das, const string &name, const string &source) throw (Error) void del attr (const string &name, int i=-1) void print (ostream &os, string pad=, bool dereference=false) Instance management functions AttrTable () AttrTable (const AttrTable &rhs) virtual AttrTable () AttrTable & operator= (const AttrTable &rhs) Accessors using an attribute name Each of the following accessors get information using the name of an attribute. They perform a simple search for the name in this attribute table only; sub-tables are not searched and the dot notation is not recognized. AttrTable get attr table (const string &name) Get an attribute container.

22 18 OPeNDAP Class Documentation AttrTable get attr table (const char name) string get type (const string &name) Get the type name of an attribute within this attribute table. string get type (const char name) AttrType get attr type (const string &name) Get the type of an attribute. AttrType get attr type (const char name) unsigned int get attr num (const string &name) Get the number of attributes in this container. unsigned int get attr num (const char name) string get attr (const string &name, unsigned int i=0) Get the value of an attribute. string get attr (const char name, unsigned int i=0) vector string get attr vector (const string &name) Get a vector-valued attribute. vector string get attr vector (const char name) Accessors using a Pix The following accessors get information using a Pix pseudo-index pointer into the AttrTable structure. Pix first attr () Get a reference to the first entry in this attribute table. void next attr (Pix &p) Increment a Pix pointer into the attribute table. string get name (Pix p) Returns the name of the attribute table. bool is container (Pix p) Returns true if the attribute is a container. AttrTable get attr table (Pix p) Return an attribute container. string get type (Pix p) Get the type name of an attribute. AttrType get attr type (Pix p) Get the type of an attribute.

23 3.2 AttrTable Class Reference 19 unsigned int get attr num (Pix p) Get the number of attributes in this container. string get attr (Pix p, unsigned int i=0) Return the value of an attribute. vector string get attr vector (Pix p) Return a vector-valued attribute. Instance management AttrTable () AttrTable (const AttrTable &rhs) virtual AttrTable () AttrTable & operator= (const AttrTable &rhs) get attr table get type unsigned int get size () const string get name () AttrTable find container (const string &target) Pix find (const string &target, AttrTable at) AttrTable get attr table (const string &name) Get an attribute container. AttrTable get attr table (const char name) string get type (const string &name) string get type (const char name) get attr type AttrType get attr type (const string &name) AttrType get attr type (const char name) get attr num get attr unsigned int get attr num (const string &name) unsigned int get attr num (const char name) string get attr (const string &name, unsigned int i=0) string get attr (const char name, unsigned int i=0)

24 20 OPeNDAP Class Documentation get attr vector vector string get attr vector (const string &name) vector string get attr vector (const char name) get information using a Pix Accessors that use names Pix first attr () void next attr (Pix &p) string get name (Pix p) bool is container (Pix p) AttrTable get attr table (Pix p) string get type (Pix p) AttrType get attr type (Pix p) unsigned int get attr num (Pix p) string get attr (Pix p, unsigned int i=0) vector string get attr vector (Pix p) append attr() Adds an attribute to the table. If the given name already refers to an attribute, and the attribute has a value, the given value is appended to the attribute vector. Calling this function repeatedly is the way to append to an attribute vector. The function returns an error condition if the attribute is a container, or if the type of the input value does not match the existing attribute s type. Use append - container() to add container attributes. This method performs a simple search for name in this attribute table only; subtables are not searched and the dot notation is not recognized. Returns the length of the added attribute value. name The name of the attribute to add or modify. type The type of the attribute to add or modify. value The value to add to the attribute table. Accessors that use a pix Accessors void set name (const string &n) unsigned int append attr (const string &name, const string &type, const string &value) throw (Error) unsigned int append attr (const char name, const char type, const char value) throw (Error) attr alias() Adds an alias to the set of attributes. Once an alias is inserted into an attribute table, reading the attributes for alias will return those stored for name. Two forms for this function exist: one searches for name in the AttrTable referenced by at while the other uses this. You can use DAS::get attr table() to get the attribute table for an arbitrary name.

25 3.2 AttrTable Class Reference 21 See also: get attr table Deprecated: bool attr alias (const string &alias, AttrTable at, const string &name) bool attr alias (const string &alias, const string &name) Protected Methods void clone (const AttrTable &at) void simple print (ostream &os, string pad, Pix p, bool dereference) void clone (const AttrTable &at) void simple print (ostream &os, string pad, Pix p, bool dereference) Detailed Description Contains the attributes for a dataset. An AttrTable ( Attribute Table ) stores a set of names and, for each name, either a type and a value, or another attribute table. The attribute value can be a vector containing many values of the same type. The attributes can have any of the types listed in the AttrType list. However, all attribute types are stored as string data, except for the container type, which is stored as a pointer to another attribute table. Each element in the attribute table can itself be an attribute table. The table can also contain alias attributes whose value is given by the value of another attribute to which it is linked. The attribute tables have a standard printed representation. There is a member function print() for writing this form. Use the DAS::parse() function to read the printed form. An attribute table might look something like this: string long_name "Weekly Means of Sea Surface Temperature"; actual_range { Float64 min -1.8; Float64 max 35.09; } string units "degc"; conversion_data { Float64 add_offset 0.; Float64 scale_factor ; } Int32 missing_value 32767;

26 22 OPeNDAP Class Documentation Here, long name, units, and missing value are simple attributes, and actual range and conversion data are container attributes containing other attribute tables. See also: DAS, AttrType Definition at line 108 of file AttrTable.h Member Function Documentation void AttrTable::add container alias (const string & name, AttrTable src) throw (Error) Add an alias to a container held by this attribute table. name The name of the alias. May not use dot notation. src The existing attribute container to alias. Exceptions: Error if an attribute, container or alias called name already exists in this attribute table void AttrTable::add container alias (const string & name, AttrTable src) throw (Error) Add an alias to a container held by this attribute table. name The name of the alias. May not use dot notation. src The existing attribute container to alias. Exceptions: Error if an attribute, container or alias called name already exists in this attribute table. Definition at line 604 of file AttrTable.cc.

27 3.2 AttrTable Class Reference void AttrTable::add value alias (AttrTable das, const string & name, const string & source) throw (Error) Add an alias to an attribute held by this attribute table. name The name of the alias. May not use dot notation. source The name of the attribute to alias. May use dot notation. Exceptions: Error if the attribute table already contains an attribute, container or alias called name or if an attribute called source does not exist void AttrTable::add value alias (AttrTable das, const string & name, const string & source) throw (Error) Add an alias to an attribute held by this attribute table. das name The name of the alias. May not use dot notation. source The name of the attribute to alias. May use dot notation. Exceptions: Error if the attribute table already contains an attribute, container or alias called name or if an attribute called source does not exist. Definition at line 635 of file AttrTable.cc. References attr map, get attr table, and is container. Referenced by attr alias unsigned int AttrTable::append attr (const string & name, const string & type, const string & attr) throw (Error) Add an attribute to the table. If the given name already refers to an attribute, and the attribute has a value, the given value is appended to the attribute vector. Calling this function repeatedly is the way to append to an attribute vector.

28 24 OPeNDAP Class Documentation The function returns an error condition if the attribute is a container, or if the type of the input value does not match the existing attribute s type. Use append container() to add container attributes. This method performs a simple search for name in this attribute table only; sub-tables are not searched and the dot notation is not recognized. Returns the length of the added attribute value. name The name of the attribute to add or modify. type The type of the attribute to add or modify. attr The value to add to the attribute table. Definition at line 511 of file AttrTable.cc AttrTable AttrTable::append container (AttrTable at, const string & name) throw (Error) Append a new attribute container to this attribute table. The new container is at and its name is set to name. If this attribute table already contains an attribute container called name an exception is thrown. A pointer to the new AttrTable object AttrTable AttrTable::append container (const string & name) throw (Error) Create and append an attribute container to this AttrTable. If this attribute table already contains an attribute container called name an exception is thrown. A pointer to the new AttrTable object.

29 3.2 AttrTable Class Reference AttrTable AttrTable::append container (AttrTable at, const string & name) throw (Error) Add a container to the attribute table. Append a new attribute container to this attribute table. The new container is at and its name is set to name. If this attribute table already contains an attribute container called name an exception is thrown. A pointer to the new AttrTable object. Definition at line 576 of file AttrTable.cc AttrTable AttrTable::append container (const string & name) throw (Error) Add a container to the attribute table. Create and append an attribute container to this AttrTable. If this attribute table already contains an attribute container called name an exception is thrown. A pointer to the new AttrTable object. Definition at line 561 of file AttrTable.cc. Referenced by DAS::add table, and DAS::DAS bool AttrTable::attr alias (const string & alias, const string & name) Deprecated: alias The alias to insert into the attribute table. name The name of the already-existing attribute to which the alias will refer bool AttrTable::attr alias (const string & alias, AttrTable at, const string & name) alias The alias to insert into the attribute table.

30 26 OPeNDAP Class Documentation name The name of the already-existing attribute to which the alias will refer. Deprecated: at An attribute table in which to insert the alias bool AttrTable::attr alias (const string & alias, const string & name) Deprecated: alias The alias to insert into the attribute table. name The name of the already-existing attribute to which the alias will refer. Definition at line 711 of file AttrTable.cc. References attr alias bool AttrTable::attr alias (const string & alias, AttrTable at, const string & name) Adds an alias to the set of attr alias(). Once an alias is inserted into an attribute table, reading the attributes for alias will return those stored for name. Two forms for this function exist: one searches for name in the AttrTable referenced by at while the other uses this. You can use DAS::get attr table() to get the attribute table for an arbitrary name. See also: get attr table Deprecated: alias The alias to insert into the attribute table. name The name of the already-existing attribute to which the alias will refer. at An attribute table in which to insert the alias.

31 3.2 AttrTable Class Reference 27 Definition at line 700 of file AttrTable.cc. References add value alias. Referenced by attr alias void AttrTable::clone (const AttrTable & at) [protected] Clone the given attribute table in this void AttrTable::clone (const AttrTable & at) [protected] Clone the given attribute table in this. Definition at line 178 of file AttrTable.cc. References attr map void AttrTable::del attr (const string & name, int i = -1) Delete the attribute named name. If i is given, and the attribute has a vector value, delete the i$ th$ element of the vector. You can use this function to delete container attributes, although the i parameter has no meaning for that operation. name The name of the attribute to delete. This can be an attribute of any type, including containers. However, this method looks only in this attribute table and does not recognize the dot notation. i If the named attribute is a vector, and i is non-negative, the i-th entry in the vector is deleted, and the array is repacked. If i equals -1 (the default), the entire attribute is deleted void AttrTable::del attr (const string & name, int i = -1) Deletes an attribute. Delete the attribute named name. If i is given, and the attribute has a vector value, delete the i$ th$ element of the vector. You can use this function to delete container attributes, although the i parameter has no meaning for that operation.

32 28 OPeNDAP Class Documentation name The name of the attribute to delete. This can be an attribute of any type, including containers. However, this method looks only in this attribute table and does not recognize the dot notation. i If the named attribute is a vector, and i is non-negative, the i-th entry in the vector is deleted, and the array is repacked. If i equals -1 (the default), the entire attribute is deleted. Definition at line 739 of file AttrTable.cc Pix AttrTable::find (const string & target, AttrTable at) Look for an attribute or an attribute container. If used to search for an attribute container, this method returns the container s parent using the value-result parameter at and a reference to the container using the Pix return value. If used to search for an attribute, the attribute s container is returned using at; the attribute itself can be accessed using the Pix return value. target The name (using dot notation) of the attribute or container to find. at A value-result used to return the attribute container in which target was found. Null if target was not found. A Pix which can be used to access target from within at. Null if the attribute or container does not exist Pix AttrTable::find (const string & target, AttrTable at) Find an attribute or container with a given name. Look for an attribute or an attribute container. If used to search for an attribute container, this method returns the container s parent using the value-result parameter at and a reference to the container using the Pix return value. If used to search for an attribute, the attribute s container is returned using at; the attribute itself can be accessed using the Pix return value. target The name (using dot notation) of the attribute or container to find. at A value-result used to return the attribute container in which target was found. Null if target was not found.

33 3.2 AttrTable Class Reference 29 A Pix which can be used to access target from within at. Null if the attribute or container does not exist. Definition at line 56 of file AttrTable.cc. References find container. Referenced by find container AttrTable AttrTable::find container (const string & target) Look in this attribute table for an attribute container named target. The search starts at this attribute table; target should use the dot notation to name containers held within children of this attribute table. To search the entire DAS object, make sure to invoke this method from that object. target The attribute container to find. A pointer to the attribute table or null if the container cannot be found AttrTable AttrTable::find container (const string & target) Find an attribute with a given name. Look in this attribute table for an attribute container named target. The search starts at this attribute table; target should use the dot notation to name containers held within children of this attribute table. To search the entire DAS object, make sure to invoke this method from that object. target The attribute container to find. A pointer to the attribute table or null if the container cannot be found. Definition at line 99 of file AttrTable.cc. References find. Referenced by find, and get attr table.

34 30 OPeNDAP Class Documentation Accessors that use names Pix AttrTable::first attr () Get a reference to the first entry in this attribute table. Pix; returns null if there s nothing in the list Pix AttrTable::first attr () Get a reference to the first entry in this attribute table. Pix; returns null if there s nothing in the list. Definition at line 254 of file AttrTable.cc. Referenced by DAS::first var string AttrTable::get attr (Pix p, unsigned int i = 0) Returns the value of an attribute. If the attribute has a vector value, you can indicate which is the desired value with the index argument, i. If the argument is omitted, the first value is returned. If the attribute has only a single value, the index argument is ignored. If i is greater than the number of elements in the attribute, an error is produced. All values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. p i The attribute value index, zero-based. If the indicated attribute is a container, this function returns the string None. If using a name to refer to the attribute and the named attribute does not exist, return the empty string.

35 3.2 AttrTable Class Reference string AttrTable::get attr (const string & name, unsigned int i = 0) Get the value of an attribute. If the attribute has a vector value, you can indicate which is the desired value with the index argument, i. If the argument is omitted, the first value is returned. If the attribute has only a single value, the index argument is ignored. If i is greater than the number of elements in the attribute, an error is produced. All values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program string AttrTable::get attr (Pix p, unsigned int i = 0) Return the value of an attribute. Returns the value of an attribute. If the attribute has a vector value, you can indicate which is the desired value with the index argument, i. If the argument is omitted, the first value is returned. If the attribute has only a single value, the index argument is ignored. If i is greater than the number of elements in the attribute, an error is produced. All values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. p i The attribute value index, zero-based. If the indicated attribute is a container, this function returns the string None. If using a name to refer to the attribute and the named attribute does not exist, return the empty string. Definition at line 415 of file AttrTable.cc string AttrTable::get attr (const string & name, unsigned int i = 0) Get the value of an attribute. Get the value of an attribute. If the attribute has a vector value, you can indicate which is the desired value with the index argument, i. If the argument is omitted, the first value is returned. If the attribute has only a single value, the index argument is ignored. If i is greater than the number of elements in the attribute, an error is produced. All values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. Definition at line 435 of file AttrTable.cc.

36 32 OPeNDAP Class Documentation unsigned int AttrTable::get attr num (Pix p) If the indicated attribute is a container attribute, this function returns the number of attributes in its attribute table. If the indicated attribute is not a container, the method returns the number of values for the attribute (1 for a scalar attribute, N for a vector attribute value). p The number of elements in the attribute unsigned int AttrTable::get attr num (const string & name) If the indicated attribute is a container attribute, this function returns the number of attributes in its attribute table. If the indicated attribute is not a container, the method returns the number of values for the attribute (1 for a scalar attribute, N for a vector attribute value) unsigned int AttrTable::get attr num (Pix p) Get the number of attributes in this container. If the indicated attribute is a container attribute, this function returns the number of attributes in its attribute table. If the indicated attribute is not a container, the method returns the number of values for the attribute (1 for a scalar attribute, N for a vector attribute value). p The number of elements in the attribute. Definition at line 369 of file AttrTable.cc unsigned int AttrTable::get attr num (const string & name) Get the number of attributes in this container. If the indicated attribute is a container attribute, this function returns the number of attributes in its attribute table. If the indicated attribute is not a container, the method

37 3.2 AttrTable Class Reference 33 returns the number of values for the attribute (1 for a scalar attribute, N for a vector attribute value). Definition at line 385 of file AttrTable.cc AttrTable AttrTable::get attr table (Pix p) Get the attribute container referenced by p. If no such container exists, then return null. p Reference to a table contained by this object. The child attribute table AttrTable AttrTable::get attr table (Pix p) Return an attribute container. Get the attribute container referenced by p. If no such container exists, then return null. p Reference to a table contained by this object. The child attribute table. Definition at line 291 of file AttrTable.cc. References get attr table AttrType AttrTable::get attr type (Pix p) Get the type of an attribute. p The datatype of this attribute in an instance of AttrType.

38 34 OPeNDAP Class Documentation AttrType AttrTable::get attr type (const string & name) Get the type of an attribute using AttrType AttrType AttrTable::get attr type (Pix p) Get the type of an attribute. p The datatype of this attribute in an instance of AttrType. Definition at line 338 of file AttrTable.cc AttrType AttrTable::get attr type (const string & name) Get the type of an attribute. The AttrType value describing the attribute. Definition at line 347 of file AttrTable.cc. References get attr type. Referenced by get attr type vector string AttrTable::get attr vector (Pix p) Returns a pointer to the vector of values associated with the attribute referenced by Pix p or named name. Note that all values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. p If the indicated attribute is a container, this function returns the null pointer. Otherwise returns a pointer to the the attribute vector value.

39 3.2 AttrTable Class Reference vector string AttrTable::get attr vector (const string & name) Get a pointer to the vector of values associated with the attribute referenced by Pix p or named name. Note that all values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. If the indicated attribute is a container, this function returns the null pointer. Otherwise returns a pointer to the the attribute vector value vector string AttrTable::get attr vector (Pix p) Return a vector-valued attribute. Returns a pointer to the vector of values associated with the attribute referenced by Pix p or named name. Note that all values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. p If the indicated attribute is a container, this function returns the null pointer. Otherwise returns a pointer to the the attribute vector value. Definition at line 460 of file AttrTable.cc vector string AttrTable::get attr vector (const string & name) Get a vector-valued attribute. Get a pointer to the vector of values associated with the attribute referenced by Pix p or named name. Note that all values in an attribute table are stored as string data. They may be converted to a more appropriate internal format by the calling program. If the indicated attribute is a container, this function returns the null pointer. Otherwise returns a pointer to the the attribute vector value.

40 36 OPeNDAP Class Documentation Definition at line 479 of file AttrTable.cc. References get attr vector. Referenced by get attr vector string AttrTable::get name (Pix p) Returns the name of the attribute table. Reimplemented in DAS string AttrTable::get name () Get the name of this attribute table. A string containing the name string AttrTable::get name () Get the name of this attribute table. A string containing the name. Definition at line 238 of file AttrTable.cc. Referenced by DAS::get name, print, and simple print unsigned int AttrTable::get size () const Get the number of entries in this attribute table. Attributes that are containers count one attribute, as do attributes with both scalar and vector values. The number of entries.