GeoTessCPP: geotess::GeoTessDataValue< T > Class Template Reference

GeoTessCPP 2.1 Software to facilitate storage and retrieval of 3D information about the Earth.

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions
geotess::GeoTessDataValue< T > Class Template Reference

`#include <GeoTessDataValue.h>`

Inheritance diagram for geotess::GeoTessDataValue< T >:

List of all members.

## Public Member Functions
| GeoTessDataValue (T v)
| GeoTessDataValue ()
virtual GeoTessData * | copy ()
virtual byte | getByte (int attributeIndex) const
virtual const GeoTessDataType & | getDataType () const
virtual double | getDouble (int attributeIndex) const
virtual float | getFloat (int attributeIndex) const
virtual int | getInt (int attributeIndex) const
virtual LONG_INT | getLong (int attributeIndex) const
virtual short | getShort (int attributeIndex) const
virtual void | getValue (int attributeIndex, double &val) const
virtual void | getValue (int attributeIndex, float &val) const
virtual void | getValue (int attributeIndex, LONG_INT &val) const
virtual void | getValue (int attributeIndex, int &val) const
virtual void | getValue (int attributeIndex, short &val) const
virtual void | getValue (int attributeIndex, byte &val) const
virtual void | getValues (double values[], const int &n)
virtual void | getValues (float values[], const int &n)
virtual void | getValues (LONG_INT values[], const int &n)
virtual void | getValues (int values[], const int &n)
virtual void | getValues (short values[], const int &n)
virtual void | getValues (byte values[], const int &n)
virtual bool | isNaN (int attributeIndex) const
bool | operator== (const GeoTessDataValue< T > &d) const
virtual bool | operator== (const GeoTessData &d) const
virtual GeoTessData & | setValue (int attributeIndex, double v)
virtual GeoTessData & | setValue (int attributeIndex, float v)
virtual GeoTessData & | setValue (int attributeIndex, LONG_INT v)
virtual GeoTessData & | setValue (int attributeIndex, int v)
virtual GeoTessData & | setValue (int attributeIndex, short v)
virtual GeoTessData & | setValue (int attributeIndex, byte v)
virtual int | size () const
Public Member Functions inherited from geotess::GeoTessData
virtual int | class_size () const
template<typename T >
void | fill (T fillValue)
virtual LONG_INT | getMemory ()

## Additional Inherited Members
Static Public Member Functions inherited from geotess::GeoTessData
static int | class_count ()
static string | class_name ()
static GeoTessData * | getData (const GeoTessDataType &dataType, int nAttributes)
static GeoTessData * | getData (double values[], const int &size)
static GeoTessData * | getData (const vector< double > &values)
static GeoTessData * | getData (float values[], const int &size)
static GeoTessData * | getData (const vector< float > &values)
static GeoTessData * | getData (LONG_INT values[], const int &size)
static GeoTessData * | getData (const vector< LONG_INT > &values)
static GeoTessData * | getData (int values[], const int &size)
static GeoTessData * | getData (const vector< int > &values)
static GeoTessData * | getData (short values[], const int &size)
static GeoTessData * | getData (const vector< short > &values)
static GeoTessData * | getData (byte values[], const int &size)
static GeoTessData * | getData (const vector< byte > &values)

## Detailed Description

### template<typename T>
class geotess::GeoTessDataValue< T >

Manages the data values attached to single grid node defined as a single value of type T (See DataType for supported types). The number of stored values is always 1 for this object.

## Constructor & Destructor Documentation

template<typename T>

geotess::GeoTessDataValue< T >::GeoTessDataValue | ( | T | v | ) |
| inline

Standard constructor. Sets value.

template<typename T>

geotess::GeoTessDataValue< T >::GeoTessDataValue | ( |  | ) |
| inline

Default constructor.

## Member Function Documentation

template<typename T>

virtual GeoTessData* geotess::GeoTessDataValue< T >::copy | ( |  | ) |
| inlinevirtual

Returns a copy of this DataValue.

template<typename T>

virtual byte geotess::GeoTessDataValue< T >::getByte | ( | int | attributeIndex | ) | const
| inlinevirtual

Retrieve the value of the attribute at the specified attribute index as a bute value.

Returns:
  the value of the attribute at the specified attribute index

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual const GeoTessDataType& geotess::GeoTessDataValue< T >::getDataType | ( |  | ) | const
| inlinevirtual

Retrieve the DataType of this Data object. One of DOUBLE, FLOAT, LONG, INT SHORT, BYTE

Returns:
  the DataType of this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual double geotess::GeoTessDataValue< T >::getDouble | ( | int | attributeIndex | ) | const
| inlinevirtual

Returns value as one of six intrinsic types.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual float geotess::GeoTessDataValue< T >::getFloat | ( | int | attributeIndex | ) | const
| inlinevirtual

Retrieve the value of the attribute at the specified attribute index as a float value.

Returns:
  the value of the attribute at the specified attribute index

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual int geotess::GeoTessDataValue< T >::getInt | ( | int | attributeIndex | ) | const
| inlinevirtual

Retrieve the value of the attribute at the specified attribute index as a int value.

Returns:
  the value of the attribute at the specified attribute index

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual LONG_INT geotess::GeoTessDataValue< T >::getLong | ( | int | attributeIndex | ) | const
| inlinevirtual

Retrieve the value of the attribute at the specified attribute index as a LONG_INT value.

Returns:
  the value of the attribute at the specified attribute index

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual short geotess::GeoTessDataValue< T >::getShort | ( | int | attributeIndex | ) | const
| inlinevirtual

Retrieve the value of the attribute at the specified attribute index as a short value.

Returns:
  the value of the attribute at the specified attribute index

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | double & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a double value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | float & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a float value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | LONG_INT & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a long value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | int & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a int value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | short & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a short value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValue | ( | int | attributeIndex,
|  | byte & | val
| ) |  | const
| inlinevirtual

Returns the attribute at the input attribute index as a byte value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | double | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as a double value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | float | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as a float value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | LONG_INT | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as a LONG_INT value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | int | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as an int value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | short | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as a short value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual void geotess::GeoTessDataValue< T >::getValues | ( | byte | values[],
|  | const int & | n
| ) |  |
| inlinevirtual

Copy value into the supplied array at index 0 as a byte value.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual bool geotess::GeoTessDataValue< T >::isNaN | ( | int | attributeIndex | ) | const
| inlinevirtual

Returns true if the specified attribute is NaN. when Data values are of type Byte, Short, Int and Long, this method always returns false since those types do not support NaN. float and double types are overridden and returns true if value isNaN and false otherwise.

Parameters:

  attributeIndex | The attribute value to be tested.

Returns:
  true if the value of the specified attribute is NaN.

Reimplemented from geotess::GeoTessData.

template<typename T>

bool geotess::GeoTessDataValue< T >::operator== | ( | const GeoTessDataValue< T > & | d | ) | const
| inline

Return true if the input DataValue<T> object (d) equals this DataValue<T> object.

template<typename T>

virtual bool geotess::GeoTessDataValue< T >::operator== | ( | const GeoTessData & | d | ) | const
| inlinevirtual

Return true if the input DataValue<T> object (d) equals this DataValue<T> object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | double | v
| ) |  |
| inlinevirtual

Set the value at the input attribute index to the input intrinsic.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | float | v
| ) |  |
| inlinevirtual

Set the value of the specified attributeIndex and return a reference to this Data object.

Parameters:

  attributeIndex | the index of the attribute that is to be modified.
  v | the new value that is to replace the old value.

Returns:
  a reference to this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | LONG_INT | v
| ) |  |
| inlinevirtual

Set the value of the specified attributeIndex and return a reference to this Data object.

Parameters:

  attributeIndex | the index of the attribute that is to be modified.
  v | the new value that is to replace the old value.

Returns:
  a reference to this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | int | v
| ) |  |
| inlinevirtual

Set the value of the specified attributeIndex and return a reference to this Data object.

Parameters:

  attributeIndex | the index of the attribute that is to be modified.
  v | the new value that is to replace the old value.

Returns:
  a reference to this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | short | v
| ) |  |
| inlinevirtual

Set the value of the specified attributeIndex and return a reference to this Data object.

Parameters:

  attributeIndex | the index of the attribute that is to be modified.
  v | the new value that is to replace the old value.

Returns:
  a reference to this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual GeoTessData& geotess::GeoTessDataValue< T >::setValue | ( | int | attributeIndex,
|  | byte | v
| ) |  |
| inlinevirtual

Set the value of the specified attributeIndex and return a reference to this Data object.

Parameters:

  attributeIndex | the index of the attribute that is to be modified.
  v | the new value that is to replace the old value.

Returns:
  a reference to this Data object.

Reimplemented from geotess::GeoTessData.

template<typename T>

virtual int geotess::GeoTessDataValue< T >::size | ( |  | ) | const
| inlinevirtual

Return size.

Reimplemented from geotess::GeoTessData.

The documentation for this class was generated from the following file:

- include/GeoTessDataValue.h