Detailed Description

Interface for managing Vector Data format.

#include <landr/VectorDataset.hpp>

Public Types
typedef std::list< std::pair< OGRFeature , geos::geom::Geometry > >	FeaturesList_t
	A list of pair of OGRFeature and geos::geom::Geometry related to this VectorDataset entities. More...

Public Member Functions
	VectorDataset (const std::string &FileName)
	Creates a new empty OGRDatasource in the openfluid temp directory, with filename suffixes with timestamp. More...

	VectorDataset (openfluid::core::GeoVectorValue &Value)
	Creates in the openfluid temp directory a copy of Value OGRDatasource, using Value filename suffixed with timestamp as filename. More...

	VectorDataset (const VectorDataset &Other)
	Copy constructor. More...

	~VectorDataset ()
	Delete the OGRDatasource and relative files in openfluid temp directory. More...

GDALDataset_COMPAT *	source ()
	Returns the OGRDataSource associated to this VectorDataset. More...

GDALDataset_COMPAT *	source () const
	Returns the const OGRDataSource associated to this VectorDataset. More...

void	copyToDisk (const std::string &FilePath, const std::string &FileName, bool ReplaceIfExists)
	Write to disk a copy of the OGRDataSource. More...

void	addALayer (std::string LayerName="", OGRwkbGeometryType LayerType=wkbUnknown, OGRSpatialReference *SpatialRef=nullptr)
	Add to DataSource an empty new layer. More...

OGRLayer *	layer (unsigned int LayerIndex=0)
	Get a layer of the shape. More...

OGRFeatureDefn *	layerDef (unsigned int LayerIndex=0)
	Get the Feature definition of a layer. More...

void	addAField (const std::string &FieldName, OGRFieldType FieldType=OFTString, unsigned int LayerIndex=0)
	Add a field to a layer. More...

bool	isLineType (unsigned int LayerIndex=0)
	Returns true if the VectorDataset is line type. More...

bool	isPolygonType (unsigned int LayerIndex=0)
	Returns true if the VectorDataset is polygon type. More...

bool	containsField (const std::string &FieldName, unsigned int LayerIndex=0)
	Returns true if a field exists in the LayerIndex layer. More...

int	getFieldIndex (const std::string &FieldName, unsigned int LayerIndex=0)
	Get the index of a field in the LayerIndex layer. More...

bool	isFieldOfType (const std::string &FieldName, OGRFieldType FieldType, unsigned int LayerIndex=0)
	Returns true if a field is of the type FieldType in the LayerIndex layer. More...

bool	isIntValueSet (const std::string &FieldName, int Value, unsigned int LayerIndex=0)
	Returns true if a field has the value Value in the LayerIndex layer. More...

FeaturesList_t	features (unsigned int LayerIndex=0)
	Gets the list of all features of a layer of this GeoVectorValue. More...

geos::geom::Geometry *	geometries (unsigned int LayerIndex=0)
	Gets a geos::geom::Geometry representing a collection of all the geometries of the layer LayerIndex of this GeoVectorValue. More...

bool	isPointType (unsigned int LayerIndex=0)
	Returns true if the VectorDataset is point type. More...

void	setIndexIntField (const std::string &FieldName, int BeginValue=1, unsigned int LayerIndex=0)
	Sets an integer Field with an index list (increment value one by one) More...

OGREnvelope	envelope ()
	Returns the OGREnvelope associated to this VectorDataset. More...

void	snapVertices (double Threshold, unsigned int LayerIndex=0)
	Snap the vertices of this VectorDataset. Only for Polygon or Line Type;. More...

std::string	checkTopology (double Threshold, unsigned int LayerIndex=0)
	Check the topology of this VectorDataset. Only for Polygon Type. More...

std::list< std::pair< OGRFeature , OGRFeature > >	findOverlap (unsigned int LayerIndex=0)
	Find the overlapping polygons. Only for Polygon Type;. More...

std::list< std::pair< OGRFeature , OGRFeature > >	findGap (double Threshold, unsigned int LayerIndex=0)
	Find gap between polygons. Only for Polygon Type;. More...

void	cleanOverlap (double Threshold, unsigned int LayerIndex=0)
	Clean the overlapping polygons. Only for Polygon Type;. More...

std::list< OGRFeature * >	hasDuplicateGeometry (unsigned int LayerIndex=0)
	Identify the duplicate geometry of this VectorDataset. More...

Member Typedef Documentation

◆ FeaturesList_t

typedef std::list<std::pair<OGRFeature*, geos::geom::Geometry*> > openfluid::landr::VectorDataset::FeaturesList_t

A list of pair of OGRFeature and geos::geom::Geometry related to this VectorDataset entities.

Constructor & Destructor Documentation

◆ VectorDataset() [1/3]

openfluid::landr::VectorDataset::VectorDataset ( const std::string & FileName )

Creates a new empty OGRDatasource in the openfluid temp directory, with filename suffixes with timestamp.

Parameters

FileName The name of the file to create.

Exceptions

openfluid::base::FrameworkException if fails.

◆ VectorDataset() [2/3]

openfluid::landr::VectorDataset::VectorDataset ( openfluid::core::GeoVectorValue & Value )

Creates in the openfluid temp directory a copy of Value OGRDatasource, using Value filename suffixed with timestamp as filename.

Parameters

Value The GeoVectorValue to copy

Exceptions

openfluid::base::FrameworkException if fails.

◆ VectorDataset() [3/3]

openfluid::landr::VectorDataset::VectorDataset ( const VectorDataset & Other )

Copy constructor.

Exceptions

openfluid::base::FrameworkException if fails.

◆ ~VectorDataset()

openfluid::landr::VectorDataset::~VectorDataset ( )

Delete the OGRDatasource and relative files in openfluid temp directory.

Member Function Documentation

◆ addAField()

void openfluid::landr::VectorDataset::addAField	(	const std::string &	FieldName,
		OGRFieldType	FieldType = `OFTString`,
		unsigned int	LayerIndex = `0`
	)

Add a field to a layer.

Parameters

FieldName	The name of the field to add.
FieldType	The type of the field to add (default OFTString).
LayerIndex	The index of the layer to add the field, default 0.

Exceptions

openfluid::base::FrameworkException if creating field failed.

◆ addALayer()

void openfluid::landr::VectorDataset::addALayer	(	std::string	LayerName = `""`,
		OGRwkbGeometryType	LayerType = `wkbUnknown`,
		OGRSpatialReference *	SpatialRef = `nullptr`
	)

Add to DataSource an empty new layer.

Parameters

LayerName	The name of the layer to create.
LayerType	The type of the layer to create, default wkbUnknown.
SpatialRef	The coordinate system to use for the new layer, or nullptr (default) if no coordinate system is available.

Exceptions

openfluid::base::FrameworkException if the creation of layer failed.

◆ checkTopology()

std::string openfluid::landr::VectorDataset::checkTopology	(	double	Threshold,
		unsigned int	LayerIndex = `0`
	)

Check the topology of this VectorDataset. Only for Polygon Type.

Parameters

Threshold	The maximum distance between polygon to be considered as gap.
LayerIndex	The index of the layer to query, default 0.

Returns: An non-empty string if found errors, otherwise the string is empty.

◆ cleanOverlap()

void openfluid::landr::VectorDataset::cleanOverlap	(	double	Threshold,
		unsigned int	LayerIndex = `0`
	)

Clean the overlapping polygons. Only for Polygon Type;.

Parameters

Threshold	The snapping threshold value.
LayerIndex	The index of the layer to query, default 0.

◆ containsField()

bool openfluid::landr::VectorDataset::containsField	(	const std::string &	FieldName,
		unsigned int	LayerIndex = `0`
	)

Returns true if a field exists in the LayerIndex layer.

Parameters

FieldName	The name of the field to query.
LayerIndex	The index of the layer to query, default 0.

Returns: True if the field FieldName exists, False otherwise.

◆ copyToDisk()

void openfluid::landr::VectorDataset::copyToDisk	(	const std::string &	FilePath,
		const std::string &	FileName,
		bool	ReplaceIfExists
	)

Write to disk a copy of the OGRDataSource.

Parameters

FilePath	The path to the directory where writing, will be created if needed.
FileName	The name of the file to write.
ReplaceIfExists	If true and the file FilePath/FileName already exists, overwrite it.

◆ envelope()

OGREnvelope openfluid::landr::VectorDataset::envelope ( )

Returns the OGREnvelope associated to this VectorDataset.

◆ features()

FeaturesList_t openfluid::landr::VectorDataset::features ( unsigned int LayerIndex = 0 )

Gets the list of all features of a layer of this GeoVectorValue.

Parameters

LayerIndex The index of the layer to query, default 0.

Returns: A list of OGRFeature and geos::geom::Geometry of this VectorDataset.

◆ findGap()

std::list<std::pair<OGRFeature, OGRFeature> > openfluid::landr::VectorDataset::findGap	(	double	Threshold,
		unsigned int	LayerIndex = `0`
	)

Find gap between polygons. Only for Polygon Type;.

Parameters

Threshold	The maximum distance between polygon to be considered as gap.
LayerIndex	The index of the layer to query, default 0.

Returns: A list of pair of OGRFeature* for each overlap between two polygons.

◆ findOverlap()

std::list<std::pair<OGRFeature*, OGRFeature*> > openfluid::landr::VectorDataset::findOverlap ( unsigned int LayerIndex = 0 )

Find the overlapping polygons. Only for Polygon Type;.

Parameters

LayerIndex The index of the layer to query, default 0.

Returns: A list of pair of OGRFeature* for each overlap between two polygons.

◆ geometries()

geos::geom::Geometry* openfluid::landr::VectorDataset::geometries ( unsigned int LayerIndex = 0 )

Gets a geos::geom::Geometry representing a collection of all the geometries of the layer LayerIndex of this GeoVectorValue.

Parameters

LayerIndex The index of the layer to query, default 0.

Returns: A geos::geom::Geometry.

◆ getFieldIndex()

int openfluid::landr::VectorDataset::getFieldIndex	(	const std::string &	FieldName,
		unsigned int	LayerIndex = `0`
	)

Get the index of a field in the LayerIndex layer.

Parameters

LayerIndex	The index of the layer to query, default 0.
FieldName	The name of the field to query.

Returns: The index of FieldName or -1 if field FieldName doesn't exist.

◆ hasDuplicateGeometry()

std::list<OGRFeature*> openfluid::landr::VectorDataset::hasDuplicateGeometry ( unsigned int LayerIndex = 0 )

Identify the duplicate geometry of this VectorDataset.

Parameters

LayerIndex The index of the layer to query, default 0.

Returns: A list of OGRFeature* which are duplicate.

◆ isFieldOfType()

bool openfluid::landr::VectorDataset::isFieldOfType	(	const std::string &	FieldName,
		OGRFieldType	FieldType,
		unsigned int	LayerIndex = `0`
	)

Returns true if a field is of the type FieldType in the LayerIndex layer.

Parameters

FieldName	The name of the field to query.
FieldType	The type of the field to query.
LayerIndex	The index of the layer to query, default 0.

Returns: True if the field FieldName is type FieldType.

Exceptions

openfluid::base::FrameworkException if the field doesn't exist.

◆ isIntValueSet()

bool openfluid::landr::VectorDataset::isIntValueSet	(	const std::string &	FieldName,
		int	Value,
		unsigned int	LayerIndex = `0`
	)

Returns true if a field has the value Value in the LayerIndex layer.

Parameters

FieldName	The name of the field to query.
Value	The value to query.
LayerIndex	The index of the layer to query, default 0.

Returns: True if the field has at least a feature containing the value Value, False otherwise.

◆ isLineType()

bool openfluid::landr::VectorDataset::isLineType ( unsigned int LayerIndex = 0 )

Returns true if the VectorDataset is line type.

Parameters

LayerIndex The index of the layer to compare the type, default 0.

Returns: True if the type of the layer LayerIndex is wkbLineString, false otherwise.

◆ isPointType()

bool openfluid::landr::VectorDataset::isPointType ( unsigned int LayerIndex = 0 )

Returns true if the VectorDataset is point type.

Parameters

LayerIndex The index of the layer to compare the type, default 0.

Returns: True if the type of the layer LayerIndex is wkbPoint, false otherwise.

◆ isPolygonType()

bool openfluid::landr::VectorDataset::isPolygonType ( unsigned int LayerIndex = 0 )

Returns true if the VectorDataset is polygon type.

Parameters

LayerIndex The index of the layer to compare the type, default 0.

Returns: True if the type of the layer LayerIndex is wkbPolygon, false otherwise.

◆ layer()

OGRLayer* openfluid::landr::VectorDataset::layer ( unsigned int LayerIndex = 0 )

Get a layer of the shape.

Parameters

LayerIndex The index of the asked layer, default 0.

Returns: The layer indexed LayerIndex.

◆ layerDef()

OGRFeatureDefn* openfluid::landr::VectorDataset::layerDef ( unsigned int LayerIndex = 0 )

Get the Feature definition of a layer.

Parameters

LayerIndex The index of the asked layer definition, default 0.

Returns: The OGR Feature definition of the LayerIndex layer.

◆ setIndexIntField()

void openfluid::landr::VectorDataset::setIndexIntField	(	const std::string &	FieldName,
		int	BeginValue = `1`,
		unsigned int	LayerIndex = `0`
	)

Sets an integer Field with an index list (increment value one by one)

Parameters

FieldName	The name of the field to query (must exist).
BeginValue	The begin value, default 1.
LayerIndex	The index of the layer to query, default 0.

◆ snapVertices()

void openfluid::landr::VectorDataset::snapVertices	(	double	Threshold,
		unsigned int	LayerIndex = `0`
	)

Snap the vertices of this VectorDataset. Only for Polygon or Line Type;.

Parameters

Threshold	The snapping threshold value.
LayerIndex	The index of the layer to query, default 0.

◆ source() [1/2]

GDALDataset_COMPAT* openfluid::landr::VectorDataset::source ( )

Returns the OGRDataSource associated to this VectorDataset.

◆ source() [2/2]

GDALDataset_COMPAT* openfluid::landr::VectorDataset::source ( ) const

Returns the const OGRDataSource associated to this VectorDataset.

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

landr/VectorDataset.hpp

Manual for OpenFLUID 2.1.11

Detailed Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ FeaturesList_t

Constructor & Destructor Documentation

◆ VectorDataset() [1/3]

◆ VectorDataset() [2/3]

◆ VectorDataset() [3/3]

◆ ~VectorDataset()

Member Function Documentation

◆ addAField()

◆ addALayer()

◆ checkTopology()

◆ cleanOverlap()

◆ containsField()

◆ copyToDisk()

◆ envelope()

◆ features()

◆ findGap()

◆ findOverlap()

◆ geometries()

◆ getFieldIndex()

◆ hasDuplicateGeometry()

◆ isFieldOfType()

◆ isIntValueSet()

◆ isLineType()

◆ isPointType()

◆ isPolygonType()

◆ layer()

◆ layerDef()

◆ setIndexIntField()

◆ snapVertices()

◆ source() [1/2]

◆ source() [2/2]