Inheritance diagram for code::Data2D< T3, T4, X >:
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 } |
| typedef __normal_iterator< X > | iterator |
| typedef __normal_iterator< const X > | const_iterator |
Public Member Functions | |
| Data2D () | |
| Creates a 0x0 grid. | |
| Data2D (size_t x, size_t y, const X &value=X()) | |
| Constructs a X x Y object and fills it with `value'. | |
| Data2D (size_t x, size_t y, const X **values) | |
| Constructs a X x Y object and fills it with `values'. | |
| virtual | ~Data2D () |
| This class is meant to be subclassed. | |
| Data2D | clone () const |
| Create a completely separate copy of this 2d. | |
| Data2D & | operator= (const Dim2D< X > &source) |
| Make `this' share source's data. | |
| virtual SpaceTimeRef | getSpaceTimeRef () const |
| The virtual function demanded by DataType. | |
| virtual DimType | coord_value (size_t i, size_t j) const |
| Returns the relative position of the element wrt to the first. | |
| virtual SpaceTimeRef | reference (size_t i, size_t j) const |
| Obtain the reference of corresponding coordinate. | |
| Datum< X > | data (size_t i, size_t j) const |
| Return the datum of the specified element. | |
| 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 void | invoke (Algorithm &) |
| Report an error, and halt execution because this function MUST be overridden in every descendant of DataType. | |
| 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 () |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| iterator | get_iterator (size_t row, size_t col) |
| const_iterator | get_iterator (size_t row, size_t col) const |
| X & | cell_ref (size_t row, size_t col) |
| Deprecated alternative to dim2d[row][col]. | |
| const X & | cell_ref (size_t row, size_t col) const |
| Deprecated alternative to dim2d[row][col]. | |
| X | get_val (size_t row, size_t col) const |
| Return a copy of the element in the specified coordinate. | |
| void | set_val (size_t row, size_t col, const X &value) |
| Slightly more efficient form of dim2d[row][col] = value. | |
| X * | operator[] (size_t row) |
| const X * | operator[] (size_t row) const |
| void | get_1d_bounds (size_t row, X *&setme_begin, X *&setme_end) |
| void | get_1d_bounds (size_t row, const X *&setme_begin, const X *&setme_end) const |
| void | push_back (const X *begin, const X *end) |
| Add a row of elements. | |
| void | push_back (const std::vector< X > &v) |
| Add a row of elements. | |
| void | replace_1d (size_t row, const X *first, const X *last) |
| Overwrite a 'row' of elements. | |
| void | replace_1d (int row, const std::vector< X > &v) |
| Overwrite a 'row' of elements. | |
| void | replace_2d (const Dim2D< X > &d) |
| Overwrite the entire 2D. | |
| void | set_2d (size_t x, size_t y, const X **values) |
| Repopulate the grid as an X x Y grid with a copy of `values'. | |
| void | fill (const X &val) |
| Set the entire grid to a value. | |
| void | fill (const X &val, size_t row_begin, size_t row_end, size_t col_begin, size_t col_end) |
| Fill a 2D range with the specified value. | |
| void | clear () |
| resets this object to a 0x0 matrix | |
| void | reserve (size_t rows, size_t cols) |
| ensure enough memory is allocated to populate an ROW x COL matrix. | |
| void | resize (size_t rows, size_t cols, const X &value=X()) |
| resizes to a ROW x COL grid and sets each cell to `value' | |
| void | replace (const X &old_value, const X &new_value) |
| replace every instance of old_value with new_value | |
| size_t | size_d () const |
| number of rows. | |
| size_t | size_d (size_t row) const |
| number of columns. | |
| int | dim_x () const |
| Number of rows. | |
| int | dim_y () const |
| Number of cols. | |
| Coord | size () const |
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 | shallow_copy (const Data2D &x) |
| virtual void | deep_copy (const Data2D &x) |
| virtual void | deep_copy (const DataType &source) |
| virtual void | shallow_copy (const Dim2D< X > &source) |
| virtual void | deep_copy (const Dim2D< X > &source) |
Protected Attributes | |
| InitSmartPtr< Impl > | _impl |
| The array of 1D types that is held. | |
Classes | |
| class | DimType |
| A Dimension type for Data2D, e.g. More... | |
typedef std::map< std::string, SmartPtr<DataColumn> > code::DataType::AttrMap [inherited] |
key-value pairs that describe the data.
typedef __normal_iterator<const X> code::Dim2D< X >::const_iterator [inherited] |
typedef __normal_iterator<X> code::Dim2D< X >::iterator [inherited] |
enum code::DataType::Type [inherited] |
| code::Data2D< T3, T4, X >::Data2D | ( | ) | [inline] |
Creates a 0x0 grid.
Use push_back() to fill this in.
| code::Data2D< T3, T4, X >::Data2D | ( | size_t | x, | |
| size_t | y, | |||
| const X & | value = X() | |||
| ) | [inline] |
Constructs a X x Y object and fills it with `value'.
| code::Data2D< T3, T4, X >::Data2D | ( | size_t | x, | |
| size_t | y, | |||
| const X ** | values | |||
| ) | [inline] |
Constructs a X x Y object and fills it with `values'.
| virtual code::Data2D< T3, T4, X >::~Data2D | ( | ) | [inline, virtual] |
This class is meant to be subclassed.
| const_iterator code::Dim2D< X >::begin | ( | ) | const [inline, inherited] |
| iterator code::Dim2D< X >::begin | ( | ) | [inline, inherited] |
| const X& code::Dim2D< X >::cell_ref | ( | size_t | row, | |
| size_t | col | |||
| ) | const [inline, inherited] |
Deprecated alternative to dim2d[row][col].
| X& code::Dim2D< X >::cell_ref | ( | size_t | row, | |
| size_t | col | |||
| ) | [inline, inherited] |
Deprecated alternative to dim2d[row][col].
| void code::Dim2D< X >::clear | ( | ) | [inline, inherited] |
resets this object to a 0x0 matrix
| void code::DataType::clearAttributes | ( | ) | [inline, inherited] |
| Data2D code::Data2D< T3, T4, X >::clone | ( | ) | const [inline] |
Create a completely separate copy of this 2d.
To create a copy that shares this data, use operator=
Reimplemented from code::Dim2D< X >.
Reimplemented in code::CartesianGrid2D, code::Grid2D, and code::LatLonGrid.
| virtual DimType code::Data2D< T3, T4, X >::coord_value | ( | size_t | i, | |
| size_t | j | |||
| ) | const [inline, virtual] |
Returns the relative position of the element wrt to the first.
This function needs to be implemented by subclasses.
Reimplemented in code::CartesianGrid2D, code::Grid2D, and code::LatLonGrid.
| 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.
| Datum<X> code::Data2D< T3, T4, X >::data | ( | size_t | i, | |
| size_t | j | |||
| ) | const [inline] |
Return the datum of the specified element.
| virtual void code::Dim2D< X >::deep_copy | ( | const Dim2D< X > & | source | ) | [inline, protected, virtual, inherited] |
| virtual void code::DataType::deep_copy | ( | const DataType & | source | ) | [inline, protected, virtual, inherited] |
| virtual void code::Data2D< T3, T4, X >::deep_copy | ( | const Data2D< T3, T4, X > & | x | ) | [inline, protected, virtual] |
| int code::Dim2D< X >::dim_x | ( | ) | const [inline, inherited] |
| int code::Dim2D< X >::dim_y | ( | ) | const [inline, inherited] |
| const_iterator code::Dim2D< X >::end | ( | ) | const [inline, inherited] |
| iterator code::Dim2D< X >::end | ( | ) | [inline, inherited] |
| void code::Dim2D< X >::fill | ( | const X & | val, | |
| size_t | row_begin, | |||
| size_t | row_end, | |||
| size_t | col_begin, | |||
| size_t | col_end | |||
| ) | [inline, inherited] |
Fill a 2D range with the specified value.
Equivalent, but more efficient, form of "for (i=ibegin; i<iend; ++i) for (j=jbegin; j<jend; ++j) d[i][j]=val;"
| void code::Dim2D< X >::fill | ( | const X & | val | ) | [inline, inherited] |
Set the entire grid to a value.
| void code::Dim2D< X >::get_1d_bounds | ( | size_t | row, | |
| const X *& | setme_begin, | |||
| const X *& | setme_end | |||
| ) | const [inline, inherited] |
| void code::Dim2D< X >::get_1d_bounds | ( | size_t | row, | |
| X *& | setme_begin, | |||
| X *& | setme_end | |||
| ) | [inline, inherited] |
| const_iterator code::Dim2D< X >::get_iterator | ( | size_t | row, | |
| size_t | col | |||
| ) | const [inline, inherited] |
| iterator code::Dim2D< X >::get_iterator | ( | size_t | row, | |
| size_t | col | |||
| ) | [inline, inherited] |
| X code::Dim2D< X >::get_val | ( | size_t | row, | |
| size_t | col | |||
| ) | const [inline, inherited] |
Return a copy of the element in the specified coordinate.
| 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::Data2D< T3, T4, X >::getSpaceTimeRef | ( | ) | const [inline, virtual] |
The virtual function demanded by DataType.
This function needs to be implemented by subclasses.
Implements code::DataType.
Reimplemented in code::CartesianGrid2D, code::Grid2D, and code::LatLonGrid.
| 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::DataType::invoke | ( | Algorithm & | ) | [virtual, inherited] |
Report an error, and halt execution because this function MUST be overridden in every descendant of DataType.
The descendant's implementation should pass this or *this, as is appropriate, into the argument's process() member.
Reimplemented in code::BasicIcon, code::AlgTrackStruct, code::LtgoIconStruct, code::MesoIconStruct, code::BwerIconStruct, code::CartesianGrid2D, code::CartesianGrid3D, code::SingleContourData, code::ContourData, code::DataTable, code::DEM, code::Datum< X >, code::Collection< X >, code::ElevationVolume, code::FieldArrowStruct, code::Grid2D, code::IconData, code::LatLonGrid, code::LatLonHeightGrid, code::PolarGrid, code::Radial, code::RadialSet, code::WindFieldStruct< T >, code::Collection< code::Radial >, and code::Collection< code::SingleContourData >.
| Data2D& code::Data2D< T3, T4, X >::operator= | ( | const Dim2D< X > & | source | ) | [inline] |
Make `this' share source's data.
To create a copy that doesn't share source, use clone()
Reimplemented from code::Dim2D< X >.
| const X* code::Dim2D< X >::operator[] | ( | size_t | row | ) | const [inline, inherited] |
| X* code::Dim2D< X >::operator[] | ( | size_t | row | ) | [inline, inherited] |
| void code::Dim2D< X >::push_back | ( | const std::vector< X > & | v | ) | [inline, inherited] |
Add a row of elements.
| void code::Dim2D< X >::push_back | ( | const X * | begin, | |
| const X * | end | |||
| ) | [inline, inherited] |
Add a row of elements.
| virtual SpaceTimeRef code::Data2D< T3, T4, X >::reference | ( | size_t | i, | |
| size_t | j | |||
| ) | const [inline, virtual] |
Obtain the reference of corresponding coordinate.
This function needs to be implemented by subclasses. It should be a pure virtual, but we need to instantiate Data1D's...
Reimplemented in code::CartesianGrid2D, code::DEM, code::Grid2D, and code::LatLonGrid.
| void code::Dim2D< X >::replace | ( | const X & | old_value, | |
| const X & | new_value | |||
| ) | [inline, inherited] |
replace every instance of old_value with new_value
| void code::Dim2D< X >::replace_1d | ( | int | row, | |
| const std::vector< X > & | v | |||
| ) | [inline, inherited] |
Overwrite a 'row' of elements.
The number of new and old elements must match.
| void code::Dim2D< X >::replace_1d | ( | size_t | row, | |
| const X * | first, | |||
| const X * | last | |||
| ) | [inline, inherited] |
Overwrite a 'row' of elements.
The number of old and new elements must match.
| void code::Dim2D< X >::replace_2d | ( | const Dim2D< X > & | d | ) | [inline, inherited] |
Overwrite the entire 2D.
This copies the elements from d, rather than sharing them. If you want to share them, use the assignment operator instead.
| void code::Dim2D< X >::reserve | ( | size_t | rows, | |
| size_t | cols | |||
| ) | [inline, inherited] |
ensure enough memory is allocated to populate an ROW x COL matrix.
| void code::Dim2D< X >::resize | ( | size_t | rows, | |
| size_t | cols, | |||
| const X & | value = X() | |||
| ) | [inline, inherited] |
resizes to a ROW x COL grid and sets each cell to `value'
| void code::Dim2D< X >::set_2d | ( | size_t | x, | |
| size_t | y, | |||
| const X ** | values | |||
| ) | [inline, inherited] |
Repopulate the grid as an X x Y grid with a copy of `values'.
| void code::Dim2D< X >::set_val | ( | size_t | row, | |
| size_t | col, | |||
| const X & | value | |||
| ) | [inline, inherited] |
Slightly more efficient form of dim2d[row][col] = value.
| 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] |
| virtual void code::Dim2D< X >::shallow_copy | ( | const Dim2D< X > & | source | ) | [inline, protected, virtual, inherited] |
| virtual void code::Data2D< T3, T4, X >::shallow_copy | ( | const Data2D< T3, T4, X > & | x | ) | [inline, protected, virtual] |
| class Coord code::Dim2D< X >::size | ( | ) | const [inline, inherited] |
Reimplemented in code::CartesianGrid2D, code::Grid2D, and code::LatLonGrid.
| size_t code::Dim2D< X >::size_d | ( | size_t | row | ) | const [inline, inherited] |
number of columns.
| size_t code::Dim2D< X >::size_d | ( | ) | const [inline, inherited] |
number of rows.
InitSmartPtr< Impl > code::Dim2D< X >::_impl [protected, inherited] |
The array of 1D types that is held.
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