Manual for OpenFLUID 2.1.11

Classes | Typedefs | Functions
openfluid::utils Namespace Reference

Classes

class  Binding
 Class for easier binding with other programming languages. More...
 
class  BindingAbstractOutErr
 
class  BindingVerboseMachineListener
 
class  CMakeProxy
 
class  CommandLineCommand
 
class  CommandLineOption
 
class  CommandLineParser
 Class for management of command line arguments. More...
 
class  ExternalProgram
 
class  FileDownloader
 
class  FluidHubAPIClient
 
struct  GDALDriverInfos_t
 
class  GitProxy
 
class  GrassGISProxy
 
class  KillableSingleton
 
class  MeyerSingleton
 
class  ProgramProxy
 
class  RESTClient
 

Typedefs

typedef std::map< std::string, GDALDriverInfos_tGDALDriversFilesExts_t
 
typedef std::list< std::pair< QByteArray, QByteArray > > t_HeadersList
 

Functions

const GDALDriversFilesExts_t OPENFLUID_API getOGRFilesDriversForOpenFLUID ()
 
const GDALDriversFilesExts_t OPENFLUID_API getGDALFilesDriversForOpenFLUID ()
 
const std::set< std::string > OPENFLUID_API getOGRFilesExtensionsForOpenFLUID ()
 
std::string OPENFLUID_API getOGRGDALFormatsForQFileDialogs (const GDALDriversFilesExts_t &Drivers, const std::string &AllFormatsLabel)
 
bool OPENFLUID_API isOGRInteger (OGRFieldType FieldType)
 
bool OPENFLUID_API isOGRPunctualType (OGRwkbGeometryType Type)
 
bool OPENFLUID_API isOGRLinearType (OGRwkbGeometryType Type)
 
bool OPENFLUID_API isOGRSurfacicType (OGRwkbGeometryType Type)
 

Typedef Documentation

◆ GDALDriversFilesExts_t

◆ t_HeadersList

typedef std::list<std::pair<QByteArray,QByteArray> > openfluid::utils::t_HeadersList

Function Documentation

◆ getGDALFilesDriversForOpenFLUID()

const GDALDriversFilesExts_t OPENFLUID_API openfluid::utils::getGDALFilesDriversForOpenFLUID ( )

Returns a list of GDAL drivers available in OpenFLUID for GIS vector files

Returns
an openfluid::utils::GDALDriversFilesExts_t

◆ getOGRFilesDriversForOpenFLUID()

const GDALDriversFilesExts_t OPENFLUID_API openfluid::utils::getOGRFilesDriversForOpenFLUID ( )

Returns a list of OGR drivers available in OpenFLUID for GIS vector files

Returns
an openfluid::utils::GDALDriversFilesExts_t

◆ getOGRFilesExtensionsForOpenFLUID()

const std::set<std::string> OPENFLUID_API openfluid::utils::getOGRFilesExtensionsForOpenFLUID ( )

Returns a set of GIS vector files extensions available in OpenFLUID

Returns
a set of files extensions

◆ getOGRGDALFormatsForQFileDialogs()

std::string OPENFLUID_API openfluid::utils::getOGRGDALFormatsForQFileDialogs ( const GDALDriversFilesExts_t Drivers,
const std::string &  AllFormatsLabel 
)

Returns the available GDAL/OGR formats as a QFileDialog formats string. The string is built according to GDAL/OGR available drivers. The OGRRegisterAll() and/or GDALAllRegister() instruction must be called before using this function.

Parameters
[in]DriversThe available extensions list
[in]AllFormatsLabelthe label displayed for all formats
Returns
the format string (e.g. "All vector files (*.shp *.mif *.tab);;ESRI Shapefiles (*.shp);;Mapinfo (*.mif *.tab)")

◆ isOGRInteger()

bool OPENFLUID_API openfluid::utils::isOGRInteger ( OGRFieldType  FieldType)
inline

Returns true if the given field type is an OGR integer or an OGR 64bits integer, taking into account the compatibility with both GDAL 1.xx and 2.xx

Parameters
[in]FieldTypethe OGR field type
Returns
true if the field type is integer

◆ isOGRLinearType()

bool OPENFLUID_API openfluid::utils::isOGRLinearType ( OGRwkbGeometryType  Type)
inline

Returns true if the given geometry type is a linear type (e.g. wkbLineString,

Parameters
[in]Typethe OGR geometry type
Returns
true if the geometry type is linear

◆ isOGRPunctualType()

bool OPENFLUID_API openfluid::utils::isOGRPunctualType ( OGRwkbGeometryType  Type)
inline

Returns true if the given geometry type is a punctual type (e.g. wkbPoint),

Parameters
[in]Typethe OGR geometry type
Returns
true if the geometry type is punctual

◆ isOGRSurfacicType()

bool OPENFLUID_API openfluid::utils::isOGRSurfacicType ( OGRwkbGeometryType  Type)
inline

Returns true if the given geometry type is a surfacic type (e.g. wkbPolygon),

Parameters
[in]Typethe OGR geometry type
Returns
true if the geometry type is surfacic