All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openfluid::core::GeoRasterValue Class Reference

Container class for geospatial raster data, represented by a GDAL dataset. More...

#include <core/GeoRasterValue.hpp>

Inheritance diagram for openfluid::core::GeoRasterValue:
openfluid::core::GeoValue openfluid::core::UnstructuredValue

Public Member Functions

 GeoRasterValue (std::string FilePath, std::string FileName)
 Creates a new value. More...
 
 ~GeoRasterValue ()
 Closes the opened GDAL dataset. More...
 
openfluid::core::UnstructuredValue::UnstructuredType getType () const
 Returns the type of this GeoRasterValue. More...
 
GDALDataset * get ()
 Gets the associated opened GDAL dataset in read-only access. More...
 
std::string getAbsolutePath ()
 Returns the absolute Path of this GeoRasterValue. More...
 
- Public Member Functions inherited from openfluid::core::GeoValue
 GeoValue (std::string FilePath, std::string FileName)
 
virtual ~GeoValue ()=0
 
std::string getFilePath ()
 
- Public Member Functions inherited from openfluid::core::UnstructuredValue
 UnstructuredValue ()
 
virtual ~UnstructuredValue ()
 

Protected Member Functions

void tryToOpenSource ()
 Open the GDALDataset of this GeoRasterValue. More...
 

Protected Attributes

GDALDataset * mp_Data
 The GDALDataset associated to this GeoRasterValue. More...
 
- Protected Attributes inherited from openfluid::core::GeoValue
std::string m_FilePath
 
std::string m_FileName
 
std::string m_AbsolutePath
 

Additional Inherited Members

- Public Types inherited from openfluid::core::UnstructuredValue
enum  UnstructuredType { GeoVectorValue, GeoRasterValue }
 
- Static Public Member Functions inherited from openfluid::core::GeoValue
static std::string computeAbsolutePath (std::string FilePath, std::string FileName)
 
- Static Public Member Functions inherited from openfluid::core::UnstructuredValue
static bool getValueTypeFromString (const std::string ValueTypeString, UnstructuredValue::UnstructuredType &ValueType)
 
static std::string getStringFromValueType (const UnstructuredValue::UnstructuredType ValueType)
 

Detailed Description

Container class for geospatial raster data, represented by a GDAL dataset.

Constructor & Destructor Documentation

openfluid::core::GeoRasterValue::GeoRasterValue ( std::string  FilePath,
std::string  FileName 
)

Creates a new value.

The FileName may be the name of a .jpeg, .tiff, .img or .asc file...

It doesn't open the associated GDAL dataset.

Parameters
FilePathThe path of the file(s).
FileNameThe name or the relative path of the file to open.
openfluid::core::GeoRasterValue::~GeoRasterValue ( )

Closes the opened GDAL dataset.

Member Function Documentation

GDALDataset* openfluid::core::GeoRasterValue::get ( )

Gets the associated opened GDAL dataset in read-only access.

If the dataset is not already opened, tries to open it first.

Returns
The opened GDAL dataset.
Exceptions
openfluid::base::OFExceptionif GDAL doesn't succeed to open the dataset.
std::string openfluid::core::GeoRasterValue::getAbsolutePath ( )

Returns the absolute Path of this GeoRasterValue.

openfluid::core::UnstructuredValue::UnstructuredType openfluid::core::GeoRasterValue::getType ( ) const
virtual
void openfluid::core::GeoRasterValue::tryToOpenSource ( )
protectedvirtual

Open the GDALDataset of this GeoRasterValue.

Exceptions
openfluid::base::OFExceptionif GDAL doesn't succeed to open the datasource.

Implements openfluid::core::GeoValue.

Member Data Documentation

GDALDataset* openfluid::core::GeoRasterValue::mp_Data
protected

The GDALDataset associated to this GeoRasterValue.


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