Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openfluid::core::GeoRasterValue Class Reference

#include <core/GeoRasterValue.hpp>

Inheritance diagram for openfluid::core::GeoRasterValue:
Inheritance graph
[legend]
Collaboration diagram for openfluid::core::GeoRasterValue:
Collaboration graph
[legend]

Public Member Functions

 GeoRasterValue ()=delete
 
 GeoRasterValue (const std::string &FilePath, const std::string &FileName)
 
virtual ~GeoRasterValue ()
 
openfluid::core::UnstructuredValue::UnstructuredType getType () const
 
GDALDataset * data ()
 
std::string getAbsolutePath ()
 
- Public Member Functions inherited from openfluid::core::GeoValue
 GeoValue ()=delete
 
 GeoValue (const std::string &FilePath, const std::string &FileName)
 
virtual ~GeoValue ()=0
 
std::string getFilePath ()
 
- Public Member Functions inherited from openfluid::core::UnstructuredValue
 UnstructuredValue ()=default
 
virtual ~UnstructuredValue ()
 

Protected Member Functions

void tryToOpenSource ()
 

Protected Attributes

GDALDataset * mp_Data
 
- 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 (const std::string &FilePath, const 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

◆ GeoRasterValue() [1/2]

openfluid::core::GeoRasterValue::GeoRasterValue ( )
delete

◆ GeoRasterValue() [2/2]

openfluid::core::GeoRasterValue::GeoRasterValue ( const std::string &  FilePath,
const 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
[in]FilePathThe path of the file(s).
[in]FileNameThe name or the relative path of the file to open.

◆ ~GeoRasterValue()

virtual openfluid::core::GeoRasterValue::~GeoRasterValue ( )
virtual

Closes the opened GDAL dataset.

Member Function Documentation

◆ data()

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

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::FrameworkExceptionif GDAL doesn't succeed to open the dataset.

◆ getAbsolutePath()

std::string openfluid::core::GeoRasterValue::getAbsolutePath ( )

Returns the absolute Path of this GeoRasterValue.

◆ getType()

openfluid::core::UnstructuredValue::UnstructuredType openfluid::core::GeoRasterValue::getType ( ) const
virtual

◆ tryToOpenSource()

void openfluid::core::GeoRasterValue::tryToOpenSource ( )
protectedvirtual

Open the GDALDataset of this GeoRasterValue.

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

Implements openfluid::core::GeoValue.

Member Data Documentation

◆ mp_Data

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

The GDALDataset associated to this GeoRasterValue.


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