#include <otbOGRDataSourceWrapper.h>

Inheritance diagram for otb::ogr::DataSource:

Collaboration diagram for otb::ogr::DataSource:

Classes
struct	boolean

class	layer_iter

struct	Modes

Public Types
Standard ITK typedefs
typedef DataSource	Self

typedef itk::DataObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef OGRExtendedFilenameToOptions	FileNameHelperType

Public Member Functions
Projection Reference property
bool	Clear ()

Layers modification
Layer	CreateLayer (std::string const &name, OGRSpatialReference *poSpatialRef=nullptr, OGRwkbGeometryType eGType=wkbUnknown, std::vector< std::string > const &papszOptions=std::vector< std::string >())

void	DeleteLayer (vcl_size_t i)

Layer	CopyLayer (Layer &srcLayer, std::string const &newName, std::vector< std::string > const &papszOptions=std::vector< std::string >())

Static Public Member Functions
Creation functions
static Pointer	New (std::string const &datasourcename, Modes::type mode=Modes::Read)

static Pointer	New (GDALDataset *sourcemode, Modes::type mode=Modes::Read, const std::vector< std::string > &layerOptions=std::vector< std::string >())

Standard macros
static Pointer	New ()

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

Iteration
typedef layer_iter< Layer >	iterator

typedef layer_iter< Layer const >	const_iterator

template<class >
class	layer_iter

const_iterator	begin () const

const_iterator	end () const

const_iterator	cbegin () const

const_iterator	cend () const

iterator	begin ()

iterator	end ()

int	Size (bool doForceComputation) const

std::string	GetGlobalExtent (double &ulx, double &uly, double &lrx, double &lry, bool force=false) const

OGREnvelope	GetGlobalExtent (bool force=false, std::string *outwkt=nullptr) const

void	Graft (const itk::DataObject *data) override

void	Reset (GDALDataset *source)

Layers access
Note As the following accessors are not inlined, they aren't optimized.
GDALDataset *	m_DataSource

std::vector< std::string >	m_LayerOptions

Modes::type	m_OpenMode

int	m_FirstModifiableLayerID

int	GetLayersCount () const

Layer	GetLayer (vcl_size_t i)

const Layer	GetLayer (vcl_size_t i) const

Layer	GetLayer (std::string const &name)

const Layer	GetLayer (std::string const &name) const

Layer	GetLayerChecked (vcl_size_t i)

const Layer	GetLayerChecked (vcl_size_t i) const

Layer	GetLayerChecked (std::string const &name)

const Layer	GetLayerChecked (std::string const &name) const

Layer	ExecuteSQL (std::string const &statement, OGRGeometry poSpatialFilter, char const pszDialect)

	operator int boolean::* () const

void	SyncToDisk ()

bool	HasCapability (std::string const &capabilityName) const

GDALDataset &	ogr ()

void	SetLayerCreationOptions (const std::vector< std::string > &options)

void	AddLayerCreationOptions (std::vector< std::string > options)

const std::vector< std::string > &	GetLayerCreationOptions () const

	DataSource ()

	DataSource (GDALDataset *source, Modes::type mode, const std::vector< std::string > &layerOption=std::vector< std::string >())

	~DataSource () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

static Pointer	OpenDataSource (std::string const &datasourceName, Modes::type mode)

OGRLayer *	GetLayerUnchecked (vcl_size_t i)

OGRLayer *	GetLayerUnchecked (vcl_size_t i) const

bool	IsLayerModifiable (vcl_size_t i) const

bool	IsLayerModifiable (std::string const &name) const

vcl_size_t	GetLayerID (std::string const &name) const

int	GetLayerIDUnchecked (std::string const &name) const

std::string	GetDatasetDescription () const

Detailed Description

Collection of geometric objects.

This class is meant to supersede otb::VectorData class. It provides an encapsulation of OGR classes. In that particular case, it's an encapsulation of GDALDataset.

Note

Not meant to be inherited.

This class has an entity semantics: non-copyable, nor assignable.

OGRRegisterAll() is implicitly called on construction.

The following functions haven't been encapsulated (yet?):

SetStyleTable() & GetStyleTable()
SetDriver() & GetDriver()
all functions related to the reference count.

Since: OTB v 3.14.0

Definition at line 83 of file otbOGRDataSourceWrapper.h.

Member Typedef Documentation

◆ const_iterator

typedef layer_iter<Layer const> otb::ogr::DataSource::const_iterator

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

Definition at line 257 of file otbOGRDataSourceWrapper.h.

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::ogr::DataSource::ConstPointer

Definition at line 91 of file otbOGRDataSourceWrapper.h.

◆ FileNameHelperType

typedef OGRExtendedFilenameToOptions otb::ogr::DataSource::FileNameHelperType

Definition at line 94 of file otbOGRDataSourceWrapper.h.

◆ iterator

typedef layer_iter<Layer> otb::ogr::DataSource::iterator

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

Definition at line 256 of file otbOGRDataSourceWrapper.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::ogr::DataSource::Pointer

Definition at line 90 of file otbOGRDataSourceWrapper.h.

◆ Self

typedef DataSource otb::ogr::DataSource::Self

Definition at line 88 of file otbOGRDataSourceWrapper.h.

◆ Superclass

typedef itk::DataObject otb::ogr::DataSource::Superclass

Definition at line 89 of file otbOGRDataSourceWrapper.h.

Constructor & Destructor Documentation

◆ DataSource() [1/2]

otb::ogr::DataSource::DataSource ( )

protected

Default constructor. The actual GDALDataset is using the in-memory OGRSFDriver: OGRMemDriver.

Exceptions

itk::ExceptionObject if the inner GDALDataset cannot be opened.

Note: OGRRegisterAll() is implicitly called on construction

See also: DataSource::New()

◆ DataSource() [2/2]

otb::ogr::DataSource::DataSource	(	GDALDataset *	source,
		Modes::type	mode,
		const std::vector< std::string > &	layerOption = `std::vector< std::string >()`
	)

protected

Init constructor.

Postcondition: The newly constructed object owns the source parameter.

◆ ~DataSource()

otb::ogr::DataSource::~DataSource ( )

overrideprotected

Destructor.

Postcondition: The GDALDataset owned is released (if not null).

Member Function Documentation

◆ AddLayerCreationOptions()

void otb::ogr::DataSource::AddLayerCreationOptions ( std::vector< std::string > options )

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ begin() [1/2]

iterator otb::ogr::DataSource::begin ( )

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

◆ begin() [2/2]

const_iterator otb::ogr::DataSource::begin ( ) const

inline

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

Definition at line 259 of file otbOGRDataSourceWrapper.h.

◆ cbegin()

const_iterator otb::ogr::DataSource::cbegin ( ) const

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

◆ cend()

const_iterator otb::ogr::DataSource::cend ( ) const

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

◆ Clear()

bool otb::ogr::DataSource::Clear ( )

Clears the data source.

Postcondition: The GDALDataset owned is destroyed with the dedicated function from OGR API.; m_DataSource = 0

◆ CopyLayer()

Layer otb::ogr::DataSource::CopyLayer	(	Layer &	srcLayer,
		std::string const &	newName,
		std::vector< std::string > const &	papszOptions = `std::vector< std::string >()`
	)

Copies a layer.

Parameters

[in]	srcLayer	Source layer to copy. It may come from another `DataSource`.
[in]	newName	Name of the new layer
[in]	papszOptions	Creation options

Returns: a proxy on the OGRLayer created.

Exceptions

itk::ExceptionObject in case the layer cannot be created on the data source.

Note: A proxy-class is returned instead of a plain OGRLayer in order to encapsulate all lifetime management of the OGRLayer obtained (i.e. never to be destroyed). If you want to delete a layer obtained with CreateLayer(), you must use DeleteLayer().; The papszOptions parameter may later become a std::vector<std::string>.

See also: GDALDataset::CopyLayer()

◆ CreateAnother()

virtual::itk::LightObject::Pointer otb::ogr::DataSource::CreateAnother ( void ) const

Default builder. This builder function creates a new DataSource with its default constructor. The actual GDALDataset is using the in-memory OGRSFDriver: OGRMemDriver.

Exceptions

itk::ExceptionObject if the inner GDALDataset cannot be opened.

Note: OGRRegisterAll() is implicitly called on construction.

See also: DataSource()

◆ CreateLayer()

Layer otb::ogr::DataSource::CreateLayer	(	std::string const &	name,
		OGRSpatialReference *	poSpatialRef = `nullptr`,
		OGRwkbGeometryType	eGType = `wkbUnknown`,
		std::vector< std::string > const &	papszOptions = `std::vector< std::string >()`
	)

Creates a new layer.

Parameters

[in]	name	name for the layer
	poSpatialRef	the coordinate system to use for the new layer, or NULL if no coordinate system is available.
[in]	eGType	the geometry type for the layer. Use wkbUnknown if there are no constraints on the types geometry to be written.
[in]	papszOptions	a StringList of name=value options. Options are driver specific.

Returns: a proxy on the OGRLayer created.

Exceptions

itk::ExceptionObject in case the layer cannot be created on the data source.

Note: A proxy-class is returned instead of a plain OGRLayer is order to encapsulate all lifetime management of the OGRLayer obtained (i.e. never to be destroyed). If you want to delete a layer obtained with CreateLayer(), you must use DeleteLayer().; The papszOptions parameter may later become a std::vector<std::string>.

See also: GDALDataset::CreateLayer()

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::InitializeOutputDataSource().

◆ DeleteLayer()

void otb::ogr::DataSource::DeleteLayer ( vcl_size_t i )

Deletes the i-th layer from the data source.

Parameters

[in] i layer index

Exceptions

itk::ExceptionObject	in case the index is out of range
itk::ExceptionObject	if the layer cannot be deleted from the data source.

Precondition: The data source must support the delete operation.; The index i must be in range [0, GetLayersCount()).

See also: GDALDataset::DeleteLayer()

◆ end() [1/2]

iterator otb::ogr::DataSource::end ( )

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

◆ end() [2/2]

const_iterator otb::ogr::DataSource::end ( ) const

inline

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

Definition at line 263 of file otbOGRDataSourceWrapper.h.

◆ ExecuteSQL()

Layer otb::ogr::DataSource::ExecuteSQL	(	std::string const &	statement,
		OGRGeometry *	poSpatialFilter,
		char const *	pszDialect
	)

Executes the statement..

Parameters

[in]	statement	textual description of the SQL statement.
[in]	poSpatialFilter	`Geometry` representing a spatial filter – may be null.
[in]	pszDialect	allows control of the statement dialect. If set to NULL, the OGR SQL engine will be used, except for RDBMS drivers that will use their dedicated SQL engine, unless OGRSQL is explicitly passed as the dialect.

Returns: a new Layer that contains the matching Features. In case of error, or no matching result sets, a null Layer will be returned. Check for Layer's validity before doing anything else.

Exceptions

None	even when there is an error – OGR can not report errors, neither this wrapping.

Note: The returned Layer will be automatically collected on its destruction; i.e. unlike OGR API, no need to explicitly call GDALDataset::ReleaseResultSet().

See also: GDALDataset::ExecuteSQL()

◆ GetDatasetDescription()

std::string otb::ogr::DataSource::GetDatasetDescription ( ) const

private

Get a string describing the dataset

◆ GetGlobalExtent() [1/2]

OGREnvelope otb::ogr::DataSource::GetGlobalExtent	(	bool	force = `false`,
		std::string *	outwkt = `nullptr`
	)		const

Retrieves the union of the extents of all layers.

Parameters

[in]	force	Force computation of layers extents if not available. May force the driver to walk all geometries to compute the extent.
[out]	outwkt	The Wkt of the extent projection (which is the wkt of the first layer SRS); if null, nothing is returned this way

Returns: the extent of all layers

Exceptions

itk::ExceptionObject if the layers extents can not be retrieved.

◆ GetGlobalExtent() [2/2]

std::string otb::ogr::DataSource::GetGlobalExtent	(	double &	ulx,
		double &	uly,
		double &	lrx,
		double &	lry,
		bool	force = `false`
	)		const

Retrieves the union of the extents of all layers.

Parameters

[out]	ulx	reference to upper-left x coordinate of the extent
[out]	uly	reference to upper-left y coordinate of the extent
[out]	lrx	reference to lower-right x coordinate of the extent
[out]	uly	reference to lower-right y coordinate of the extent
[in]	force	Force computation of layers extents if not available. May force the driver to walk all geometries to compute the extent.

Returns: The Wkt of the extent projection (which is the wkt of the first layer SRS)

Exceptions

itk::ExceptionObject if the layers extents can not be retrieved.

◆ GetLayer() [1/4]

Layer otb::ogr::DataSource::GetLayer ( std::string const & name )

Unchecked Accessor to a given layer.

Parameters

[in] name name of the layer to search

Returns: the layer requested, possibly a null one.

Exceptions

None

Note: Use GetLayerChecked(std::string const&) if you'd rather have an exception instead of testing whether the layer obtained is valid.

◆ GetLayer() [2/4]

const otb::ogr::Layer otb::ogr::DataSource::GetLayer ( std::string const & name ) const

inline

Unchecked Accessor to a given layer.

Parameters

[in] name name of the layer to search

Returns: the layer requested, possibly a null one.

Exceptions

None

Note: Use GetLayerChecked(std::string const&) if you'd rather have an exception instead of testing whether the layer obtained is valid.

Definition at line 64 of file otbOGRDataSourceWrapper.hxx.

◆ GetLayer() [3/4]

otb::ogr::Layer otb::ogr::DataSource::GetLayer ( vcl_size_t i )

inline

Unchecked Accessor to a given layer.

Parameters

[in] i index of the layer to access

Returns: the layer requested.

Precondition: i < GetLayersCount(), an assertion will be fired otherwise.; The layer must be available, an assertion will be fired otherwise.

Exceptions

None

Note: Use GetLayerUnchecked() if invalid indices are programming errors, or if null layers are to be expected.

Definition at line 51 of file otbOGRDataSourceWrapper.hxx.

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::AllocateOutputs(), otb::PersistentOGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::DispatchInputVectors(), otb::PersistentSamplingFilterBase< TInputImage >::DispatchInputVectors(), otb::PersistentOGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::FillOneOutput(), otb::PersistentSamplingFilterBase< TInputImage >::FillOneOutput(), otb::PersistentSamplingFilterBase< TInputImage >::GenerateOutputInformation(), otb::PersistentSamplingFilterBase< TInputImage >::InitializeOutputDataSource(), and otb::PersistentOGRDataToClassStatisticsFilter< TInputImage, TMaskImage >::Synthetize().

◆ GetLayer() [4/4]

const otb::ogr::Layer otb::ogr::DataSource::GetLayer ( vcl_size_t i ) const

inline

Definition at line 59 of file otbOGRDataSourceWrapper.hxx.

◆ GetLayerChecked() [1/4]

Layer otb::ogr::DataSource::GetLayerChecked ( std::string const & name )

Checked Accessor to a given layer.

Parameters

[in] name name of the layer to search

Returns: the layer requested, possibly a null one.

Exceptions

itk::ExceptionObject if there exist no layer by that name

Note: Use GetLayer(std::string const&) if you'd rather test the obtained layer instead of catching an exception.

◆ GetLayerChecked() [2/4]

const Layer otb::ogr::DataSource::GetLayerChecked ( std::string const & name ) const

Checked Accessor to a given layer.

Parameters

[in] name name of the layer to search

Returns: the layer requested, possibly a null one.

Exceptions

itk::ExceptionObject if there exist no layer by that name

Note: Use GetLayer(std::string const&) if you'd rather test the obtained layer instead of catching an exception.

◆ GetLayerChecked() [3/4]

Layer otb::ogr::DataSource::GetLayerChecked ( vcl_size_t i )

Checked Accessor to a given layer.

Parameters

[in] i index of the layer to access

Returns: a reference to the layer requested.

Precondition: i < GetLayersCount(), an exception is raised otherwise.; The layer must available, an exception is raised otherwise.

Note: Use GetLayer() if invalid indices, and null layers, are expected to be programming errors.

Exceptions

None

◆ GetLayerChecked() [4/4]

const otb::ogr::Layer otb::ogr::DataSource::GetLayerChecked ( vcl_size_t i ) const

inline

Checked Accessor to a given layer.

Parameters

[in] i index of the layer to access

Returns: a reference to the layer requested.

Precondition: i < GetLayersCount(), an exception is raised otherwise.; The layer must available, an exception is raised otherwise.

Note: Use GetLayer() if invalid indices, and null layers, are expected to be programming errors.

Exceptions

None

Definition at line 70 of file otbOGRDataSourceWrapper.hxx.

◆ GetLayerCreationOptions()

const std::vector<std::string>& otb::ogr::DataSource::GetLayerCreationOptions ( ) const

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ GetLayerID()

vcl_size_t otb::ogr::DataSource::GetLayerID ( std::string const & name ) const

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ GetLayerIDUnchecked()

int otb::ogr::DataSource::GetLayerIDUnchecked ( std::string const & name ) const

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ GetLayersCount()

int otb::ogr::DataSource::GetLayersCount ( ) const

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::AllocateOutputs(), otb::PersistentOGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::FillOneOutput(), otb::PersistentSamplingFilterBase< TInputImage >::FillOneOutput(), and otb::OGRDataSourceToLabelImageFilter< TOutputImage >::GenerateOutputInformation().

◆ GetLayerUnchecked() [1/2]

OGRLayer* otb::ogr::DataSource::GetLayerUnchecked ( vcl_size_t i )

private

Internal unchecked accessor to a given layer.

Parameters

[in] i index of the layer to access

Returns: a reference to the layer requested.

Precondition: i < GetLayersCount(), return 0 otherwise; The layer must available, 0 is returned otherwise.

Exceptions

None

◆ GetLayerUnchecked() [2/2]

OGRLayer * otb::ogr::DataSource::GetLayerUnchecked ( vcl_size_t i ) const

inlineprivate

otb::ogr::DataSource::GetLayerUnchecked(size_t i)

Definition at line 75 of file otbOGRDataSourceWrapper.hxx.

◆ GetNameOfClass()

virtual const char* otb::ogr::DataSource::GetNameOfClass ( ) const

virtual

Default builder. This builder function creates a new DataSource with its default constructor. The actual GDALDataset is using the in-memory OGRSFDriver: OGRMemDriver.

Exceptions

itk::ExceptionObject if the inner GDALDataset cannot be opened.

Note: OGRRegisterAll() is implicitly called on construction.

See also: DataSource()

◆ Graft()

void otb::ogr::DataSource::Graft ( const itk::DataObject * data )

override

Grafts data and information from one data source to another.

Deprecated:: OGRLayer has an embedded input iterator. As a consequence, the layer cannot support multiple access to its elements.

This is a convenience function to setup a second data source with all the meta information of another data source and use the same underlying GDALDataset.

◆ HasCapability()

bool otb::ogr::DataSource::HasCapability ( std::string const & capabilityName ) const

Returns whether a capability is available.

Parameters

[in] capabilityName name of the capability to check.

Exceptions

None

See also: GDALDataset::TestCapability()

◆ IsLayerModifiable() [1/2]

bool otb::ogr::DataSource::IsLayerModifiable ( std::string const & name ) const

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ IsLayerModifiable() [2/2]

bool otb::ogr::DataSource::IsLayerModifiable ( vcl_size_t i ) const

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ New() [1/3]

static Pointer otb::ogr::DataSource::New ( )

static

Default builder. This builder function creates a new DataSource with its default constructor. The actual GDALDataset is using the in-memory OGRSFDriver: OGRMemDriver.

Exceptions

itk::ExceptionObject if the inner GDALDataset cannot be opened.

Note: OGRRegisterAll() is implicitly called on construction.

See also: DataSource()

Referenced by otb::Wrapper::VectorPrediction< RegressionMode >::CreateOutputDataSource(), otb::Wrapper::VectorPrediction< RegressionMode >::DoExecute(), otb::Wrapper::VectorPrediction< RegressionMode >::DoUpdateParameters(), otb::Wrapper::TrainVectorBase< TInputValue, TOutputValue >::DoUpdateParameters(), otb::Wrapper::TrainVectorBase< TInputValue, TOutputValue >::ExtractSamplesWithLabel(), otb::LabelImageToVectorDataFilter< TInputImage, TPrecision >::GenerateData(), otb::LabelImageToOGRDataSourceFilter< TInputImage >::GenerateData(), otb::PersistentOGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::MakeOutput(), otb::Wrapper::VectorPrediction< RegressionMode >::ReopenDataSourceInUpdateMode(), and otb::Wrapper::TrainImagesBase::SplitTrainingAndValidationSamples().

◆ New() [2/3]

static Pointer otb::ogr::DataSource::New	(	GDALDataset *	sourcemode,
		Modes::type	mode = `Modes::Read`,
		const std::vector< std::string > &	layerOptions = `std::vector< std::string >()`
	)

static

Builder from a built GDALDataset.

Parameters

[in,out] source GDALDataset already constructed.

Returns: a newly created DataSource that assumes ownership of source.

Exceptions

Nothing

Note: OGRRegisterAll() is supposed to have been called before building source.; No condition is assumed on the non-nullity of source.

See also: DataSource(GDALDataset *)

◆ New() [3/3]

static Pointer otb::ogr::DataSource::New	(	std::string const &	datasourcename,
		Modes::type	mode = `Modes::Read`
	)

static

Builder from an existing named data source.

Parameters

[in]	datasourcename	OGR identifier of the data source
[in]	mode	opening mode (read or read-write)

Returns: a newly created DataSource.

Exceptions

itk::ExceptionObject if the inner GDALDataset cannot be opened.

Note: OGRRegisterAll() is implicitly called on construction

See also: DataSource(GDALDataset *)

◆ ogr()

GDALDataset & otb::ogr::DataSource::ogr ( )

inline

Access to raw GDALDataset. This function provides an abstraction leak in case deeper control on the underlying GDALDataset is required.

Precondition: The underlying GDALDataset must be valid, i.e. m_DataSource != 0, an assertion is fired otherwise.

Warning: You must under no circumstance try to delete the GDALDataset obtained this way.

Definition at line 45 of file otbOGRDataSourceWrapper.hxx.

References m_DataSource.

◆ OpenDataSource()

static Pointer otb::ogr::DataSource::OpenDataSource	(	std::string const &	datasourceName,
		Modes::type	mode
	)

staticprotected

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ operator int boolean::*()

otb::ogr::DataSource::operator int boolean::* ( ) const

inline

Can the data source be used (ie not null).

Hack to provide a boolean operator that is convertible only to a boolean expression to be used in if tests.

See also: Imperfect C++, Matthew Wilson, Addisson-Welsey, par 24.6

Definition at line 495 of file otbOGRDataSourceWrapper.h.

◆ PrintSelf()

void otb::ogr::DataSource::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overrideprotected

Prints self into stream.

◆ Reset()

void otb::ogr::DataSource::Reset ( GDALDataset * source )

Resets current data source with the one in parameter.

Parameters

[in,out] source source GDALDataset that this instance will own.

Exceptions

None

Postcondition: Assumes ownership of the source.

◆ SetLayerCreationOptions()

void otb::ogr::DataSource::SetLayerCreationOptions ( const std::vector< std::string > & options )

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

◆ Size()

int otb::ogr::DataSource::Size ( bool doForceComputation ) const

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

◆ SyncToDisk()

void otb::ogr::DataSource::SyncToDisk ( )

Flushes all changes to disk.

Friends And Related Function Documentation

◆ layer_iter

template<class >

friend class layer_iter

friend

Returns the number of elements in the Data Source.

Parameters

[in] doForceComputation indicates whether the size shall be computed on each layer even so it's expensive to do so.

Returns: the number of features in the Data Source, -1 if count is unknown

Exceptions

None

See also: OGRLayer::GetFeatureCount()

Definition at line 255 of file otbOGRDataSourceWrapper.h.

Member Data Documentation

◆ m_DataSource

GDALDataset* otb::ogr::DataSource::m_DataSource

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

Definition at line 579 of file otbOGRDataSourceWrapper.h.

Referenced by otb::ogr::DataSource::layer_iter< Value >::dereference(), otb::ogr::DataSource::layer_iter< Value >::equal(), otb::ogr::DataSource::layer_iter< Value >::increment(), and ogr().

◆ m_FirstModifiableLayerID

int otb::ogr::DataSource::m_FirstModifiableLayerID

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

Definition at line 582 of file otbOGRDataSourceWrapper.h.

◆ m_LayerOptions

std::vector<std::string> otb::ogr::DataSource::m_LayerOptions

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

Definition at line 580 of file otbOGRDataSourceWrapper.h.

◆ m_OpenMode

Modes::type otb::ogr::DataSource::m_OpenMode

private

Returns the number of layers.

See also: GDALDataset::GetLayersCount()

Definition at line 581 of file otbOGRDataSourceWrapper.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Standard macros

Iteration

Layers access

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ ConstPointer

◆ FileNameHelperType

◆ iterator

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ DataSource() [1/2]

◆ DataSource() [2/2]

◆ ~DataSource()

Member Function Documentation

◆ AddLayerCreationOptions()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ Clear()

◆ CopyLayer()

◆ CreateAnother()

◆ CreateLayer()

◆ DeleteLayer()

◆ end() [1/2]

◆ end() [2/2]

◆ ExecuteSQL()

◆ GetDatasetDescription()

◆ GetGlobalExtent() [1/2]

◆ GetGlobalExtent() [2/2]

◆ GetLayer() [1/4]

◆ GetLayer() [2/4]

◆ GetLayer() [3/4]

◆ GetLayer() [4/4]

◆ GetLayerChecked() [1/4]

◆ GetLayerChecked() [2/4]

◆ GetLayerChecked() [3/4]

◆ GetLayerChecked() [4/4]

◆ GetLayerCreationOptions()

◆ GetLayerID()

◆ GetLayerIDUnchecked()

◆ GetLayersCount()

◆ GetLayerUnchecked() [1/2]

◆ GetLayerUnchecked() [2/2]

◆ GetNameOfClass()

◆ Graft()

◆ HasCapability()

◆ IsLayerModifiable() [1/2]

◆ IsLayerModifiable() [2/2]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ ogr()

◆ OpenDataSource()

◆ operator int boolean::*()

◆ PrintSelf()

◆ Reset()

◆ SetLayerCreationOptions()

◆ Size()

◆ SyncToDisk()

Friends And Related Function Documentation

◆ layer_iter

Member Data Documentation

◆ m_DataSource

◆ m_FirstModifiableLayerID

◆ m_LayerOptions

◆ m_OpenMode