Inheritance diagram for code::Collection< X >:
The type D should be a valid DataType because
Collection::invoke() calls D::invoke(); and Collection::getSpaceTimeRef() calls D::getSpaceTimeRef().
Originally, type D would also need a valid DimType, Coord, and clone() but the code that requires D::DimType, D::Coord, and D::clone() has, at least for the present, been commented out in the interface and implementation of Collection.
Public Types | |
| typedef std::map< std::string, SmartPtr< DataColumn > > | AttrMap |
| key-value pairs that describe the data. | |
| RadialSet | |
| LatLonGrid | |
| LatLonHeightGrid | |
| CartesianGrid2D | |
| Grid2D | |
| DataTable | |
| WindField | |
| WindFieldLLGVolume | |
| ElevationVolume | |
| ContourData | |
| Other | |
| enum | Type { RadialSet, LatLonGrid, LatLonHeightGrid, CartesianGrid2D, Grid2D, DataTable, WindField, WindFieldLLGVolume, ElevationVolume, ContourData, Other } |
Public Member Functions | |
| Collection () | |
| Construct an empty Collection. | |
| Collection (size_t numElements) | |
| Construct the object of requested size, and fill its vector with the default X() values. | |
| Collection (SmartPtr< std::vector< X > > newVals) | |
| Construct from already existing values. | |
| Collection (const X *begin, const X *end) | |
| Construct from already existing values. | |
| virtual | ~Collection () |
| This class is meant to be subclassed. | |
| virtual void | invoke (Algorithm &alg) |
| Use this to invoke an algorithm given only the base type. | |
| virtual SpaceTimeRef | getSpaceTimeRef () const |
| Return the reference of the first element. | |
| const X & | operator[] (size_t i) const |
| Return the ith member of the array. | |
| X & | operator[] (size_t i) |
| Return the ith member of the array. | |
| const std::vector< X > & | data () const |
| Return the internal vector of Data1D. | |
| std::vector< X > & | data () |
| Return the internal vector of Data1D. | |
| X | value (size_t i) const |
| Another way to use the class, instead of using []. | |
| std::string | getTypeClassName () const |
| returns a string such as RadialSet, LatLonGrid, etc. | |
| void | copyDataType (const DataType &dt) |
| A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt. | |
| const std::string & | getTypeName () const |
| Return the TypeName of this DataType. | |
| virtual short | getType () const |
| Get enum type of this class. | |
| void | setTypeName (const std::string &) |
| Set the TypeName of this DataType. | |
| SmartPtr< DataCell > | getAttributeValue (const std::string &key) const |
| Return a single value associated with an attribute key corresponding to the function's argument. | |
| bool | getAttributeValue (const std::string &key, std::string &setme) const |
| Assign `setme' with the attribute corresponding to `key'. | |
| bool | getAttributeValue (const std::string &key, double &setme) const |
| Assign `setme' with the attribute corresponding to `key'. | |
| void | setAttributeValue (const std::string &key, const std::string &value, const std::string &unit="dimensionless") |
| Set a single-valued attribute that describes this DataType. | |
| void | setAttributeValue (const std::string &key, double value, const std::string &unit="dimensionless", const std::string &format="%g") |
| Set a single-valued attribute that describes this DataType. | |
| void | setAttribute (const std::string &key, SmartPtr< DataColumn > value) |
| Set a multiple-valued attribute that describes this DataType. | |
| SmartPtr< DataColumn > | getAttribute (const std::string &key) const |
| Get the attribute value for a particular key. | |
| const AttrMap & | getAttributes () const |
| Get the entire map of attributes available for this data type. | |
| virtual double | getRawValue (const Location &, bool=false) const |
| Gets raw value from data set. | |
| virtual TimeInterval | getExpiryInterval () const |
| Return 15 minutes as the length of time for which this DataType is valid. | |
| bool | hasQuality () const |
| const DataType & | getQuality () const |
| void | setQuality (SmartPtr< DataType > dt) |
| void | clearAttributes () |
Static Public Attributes | |
| static const std::string | IsTableData |
| static const std::string | Unit |
| static const std::string | ColorMap |
| static const std::string | ExpiryInterval |
Protected Member Functions | |
| virtual void | deep_copy (const DataType &source) |
typedef std::map< std::string, SmartPtr<DataColumn> > code::DataType::AttrMap [inherited] |
key-value pairs that describe the data.
enum code::DataType::Type [inherited] |
| code::Collection< X >::Collection | ( | ) | [inline] |
Construct an empty Collection.
Use data().push_back() to fill this in.
| code::Collection< X >::Collection | ( | size_t | numElements | ) | [inline] |
Construct the object of requested size, and fill its vector with the default X() values.
| code::Collection< X >::Collection | ( | SmartPtr< std::vector< X > > | newVals | ) | [inline] |
Construct from already existing values.
| code::Collection< X >::Collection | ( | const X * | begin, | |
| const X * | end | |||
| ) | [inline] |
Construct from already existing values.
| virtual code::Collection< X >::~Collection | ( | ) | [inline, virtual] |
This class is meant to be subclassed.
| void code::DataType::clearAttributes | ( | ) | [inline, inherited] |
| void code::DataType::copyDataType | ( | const DataType & | dt | ) | [inherited] |
A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt.
Attributes with the same name will be over-written, other attributes will remain unchanged.
| std::vector< X >& code::SimpleCollection< X >::data | ( | ) | [inline, inherited] |
Return the internal vector of Data1D.
| const std::vector< X >& code::SimpleCollection< X >::data | ( | ) | const [inline, inherited] |
Return the internal vector of Data1D.
| virtual void code::DataType::deep_copy | ( | const DataType & | source | ) | [inline, protected, virtual, inherited] |
| SmartPtr< DataColumn > code::DataType::getAttribute | ( | const std::string & | key | ) | const [inherited] |
Get the attribute value for a particular key.
| key | attribute key |
getAttributes() if you don't know the attribute key.
| const AttrMap& code::DataType::getAttributes | ( | ) | const [inline, inherited] |
Get the entire map of attributes available for this data type.
getAttributeValue for a convenient get.
| bool code::DataType::getAttributeValue | ( | const std::string & | key, | |
| double & | setme | |||
| ) | const [inherited] |
Assign `setme' with the attribute corresponding to `key'.
| bool code::DataType::getAttributeValue | ( | const std::string & | key, | |
| std::string & | setme | |||
| ) | const [inherited] |
Assign `setme' with the attribute corresponding to `key'.
| SmartPtr< DataCell > code::DataType::getAttributeValue | ( | const std::string & | key | ) | const [inherited] |
Return a single value associated with an attribute key corresponding to the function's argument.
If no such attribute key exists, then return the NULL SmartPtr. In case multiple values are associated with the key, only the first item is returned.
| virtual TimeInterval code::DataType::getExpiryInterval | ( | ) | const [virtual, inherited] |
| const DataType& code::DataType::getQuality | ( | ) | const [inline, inherited] |
| virtual double code::DataType::getRawValue | ( | const Location & | , | |
| bool | = false | |||
| ) | const [inline, virtual, inherited] |
Gets raw value from data set.
Reimplemented in code::CartesianGrid2D, code::CartesianGrid3D, code::ElevationVolume, code::LatLonGrid, code::LatLonHeightGrid, code::RadialSet, code::SparseGrid, and code::WindFieldLLGVolume.
| virtual SpaceTimeRef code::Collection< X >::getSpaceTimeRef | ( | ) | const [inline, virtual] |
Return the reference of the first element.
Implements code::DataType.
Reimplemented in code::ContourData, and code::RadialSet.
| virtual short code::DataType::getType | ( | ) | const [inline, virtual, inherited] |
Get enum type of this class.
Reimplemented in code::CartesianGrid2D, code::ContourData, code::DataTable, code::ElevationVolume, code::Grid2D, code::LatLonGrid, code::LatLonHeightGrid, code::PolarGrid, code::RadialSet, code::WindFieldLLGVolume, and code::WindFieldStruct< T >.
| std::string code::DataType::getTypeClassName | ( | ) | const [inherited] |
returns a string such as RadialSet, LatLonGrid, etc.
See the enum Type for all the possible options. Subclasses need only to over-ride getType()
| const std::string& code::DataType::getTypeName | ( | ) | const [inherited] |
| bool code::DataType::hasQuality | ( | ) | const [inline, inherited] |
| virtual void code::Collection< X >::invoke | ( | Algorithm & | alg | ) | [inline, virtual] |
Use this to invoke an algorithm given only the base type.
Reimplemented from code::DataType.
Reimplemented in code::ContourData, and code::RadialSet.
| X & code::SimpleCollection< X >::operator[] | ( | size_t | i | ) | [inline, inherited] |
Return the ith member of the array.
No bounds check is done.
| const X & code::SimpleCollection< X >::operator[] | ( | size_t | i | ) | const [inline, inherited] |
Return the ith member of the array.
No bounds check is done.
| void code::DataType::setAttribute | ( | const std::string & | key, | |
| SmartPtr< DataColumn > | value | |||
| ) | [inherited] |
Set a multiple-valued attribute that describes this DataType.
If value is 0 (i.e. invalid), this attribute will be removed from the map.
| void code::DataType::setAttributeValue | ( | const std::string & | key, | |
| double | value, | |||
| const std::string & | unit = "dimensionless", |
|||
| const std::string & | format = "%g" | |||
| ) | [inherited] |
Set a single-valued attribute that describes this DataType.
This is a convenience function that allows you to set a dimensionless number as the value of an attribute.
If the attribute key does not already exist, then it will be constructed.
| void code::DataType::setAttributeValue | ( | const std::string & | key, | |
| const std::string & | value, | |||
| const std::string & | unit = "dimensionless" | |||
| ) | [inherited] |
Set a single-valued attribute that describes this DataType.
This is a convenience function that allows you to set a text string as the value of an attribute.
If the attribute key does not already exist, then it will be constructed. The empty string may NOT be used as a value for the attribute; this function will return immediately if the value is the empty string.
| void code::DataType::setTypeName | ( | const std::string & | ) | [inherited] |
| X code::SimpleCollection< X >::value | ( | size_t | i | ) | const [inline, inherited] |
Another way to use the class, instead of using [].
const std::string code::DataType::ColorMap [static, inherited] |
const std::string code::DataType::ExpiryInterval [static, inherited] |
const std::string code::DataType::IsTableData [static, inherited] |
const std::string code::DataType::Unit [static, inherited] |
1.4.7