Collection of geometric objects. More...

#include <otbOGRDataSourceWrapper.h>

Inheritance diagram for otb::ogr::DataSource:

Collaboration diagram for otb::ogr::DataSource:

Classes
struct	boolean
class	layer_iter
	Implementation class for `Layer` iterator. More...
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

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
bool	Clear ()
virtual void	CopyInformation (const DataObject *)
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
std::string	GetGlobalExtent (double &ulx, double &uly, double &lrx, double &lry, bool force=false) const
OGREnvelope	GetGlobalExtent (bool force=false, std::string *outwkt=0) const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const unsigned long &	GetPipelineMTime ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const itk::DataObject *data)
bool	HasCapability (std::string const &capabilityName) const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize ()
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
OGRDataSource &	ogr ()
	operator int boolean::* () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion ()
virtual void	Register () const
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
void	Reset (OGRDataSource *source)
virtual void	ResetPipeline ()
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPipelineMTime (unsigned long time)
virtual void	SetReferenceCount (int)
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
int	Size (bool doForceComputation) const
void	SyncToDisk ()
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
Layers modification

Layer	CreateLayer (std::string const &name, OGRSpatialReference *poSpatialRef=NULL, 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, char **papszOptions=NULL)
Layers access
Note: As the following accessors are not inlined, they aren't optimized.
int	GetLayersCount () const
Layer	GetLayer (vcl_size_t i)
Layer const	GetLayer (vcl_size_t i) const

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

Layer	GetLayerChecked (vcl_size_t i)
Layer const	GetLayerChecked (vcl_size_t i) const

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

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

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalReleaseDataFlag ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalReleaseDataFlag (bool val)
static void	SetGlobalWarningDisplay (bool flag)
Creation functions

static Pointer	New (std::string const &datasourcename, Modes::type mode=Modes::Read)
static Pointer	New (OGRDataSource *sourcemode, Modes::type mode=Modes::Read)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	DataSource ()
	DataSource (OGRDataSource *source, Modes::type mode)
virtual	~DataSource ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()

Static Protected Member Functions
static Pointer	OpenDataSource (std::string const &datasourceName, Modes::type mode)

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
vcl_size_t	GetLayerID (std::string const &name) const
int	GetLayerIDUnchecked (std::string const &name) const
OGRLayer *	GetLayerUnchecked (vcl_size_t i)
OGRLayer *	GetLayerUnchecked (vcl_size_t i) const
	otb::ogr::DataSource::GetLayerUnchecked(size_t i)
bool	IsLayerModifiable (vcl_size_t i) const
bool	IsLayerModifiable (std::string const &name) const

Private Attributes
OGRDataSource *	m_DataSource
int	m_FirstModifiableLayerID
Modes::type	m_OpenMode

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
class	layer_iter
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
iterator	begin ()
iterator	end ()

Detailed Description

Collection of geometric objects.

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

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 63 of file otbOGRDataSourceWrapper.h.

Member Typedef Documentation

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

Definition at line 224 of file otbOGRDataSourceWrapper.h.

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

Reimplemented from itk::DataObject.

Definition at line 71 of file otbOGRDataSourceWrapper.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

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

Definition at line 223 of file otbOGRDataSourceWrapper.h.

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

Reimplemented from itk::DataObject.

Definition at line 70 of file otbOGRDataSourceWrapper.h.

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

Standard class typedefs.

Reimplemented from itk::DataObject.

Definition at line 68 of file otbOGRDataSourceWrapper.h.

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

Reimplemented from itk::DataObject.

Definition at line 69 of file otbOGRDataSourceWrapper.h.

Constructor & Destructor Documentation

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

protected

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

Exceptions:

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

Note:: OGRRegisterAll() is implicitly called on construction

See also:: DataSource::New()

Definition at line 116 of file otbOGRDataSourceWrapper.cxx.

References otb::ogr::Drivers::Init(), and m_DataSource.

otb::ogr::DataSource::DataSource	(	OGRDataSource *	source,
		Modes::type	mode
	)

protected

Init constructor.

Postcondition:: The newly constructed object owns the source parameter.

Definition at line 132 of file otbOGRDataSourceWrapper.cxx.

References GetLayersCount(), and m_FirstModifiableLayerID.

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

protectedvirtual

Destructor.

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

Definition at line 234 of file otbOGRDataSourceWrapper.cxx.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

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

inline

Definition at line 226 of file otbOGRDataSourceWrapper.h.

References cbegin().

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

Definition at line 252 of file otbOGRDataSourceWrapper.cxx.

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

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

Definition at line 242 of file otbOGRDataSourceWrapper.cxx.

Referenced by begin().

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

Definition at line 247 of file otbOGRDataSourceWrapper.cxx.

Referenced by end().

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

Clears the data source.

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

Definition at line 43 of file otbOGRDataSourceWrapper.cxx.

References Reset().

virtual void itk::DataObject::CopyInformation ( const DataObject * )

inlinevirtualinherited

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 435 of file itkDataObject.h.

otb::ogr::Layer otb::ogr::DataSource::CopyLayer	(	Layer &	srcLayer,
		std::string const &	newName,
		char **	papszOptions = `NULL`
	)

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:: OGRDataSource::CopyLayer()

Definition at line 363 of file otbOGRDataSourceWrapper.cxx.

References otb::ogr::Layer::GetName(), and otb::ogr::Layer::ogr().

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

virtual

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

Exceptions:

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

Note:: OGRRegisterAll() is implicitly called on construction.

See also:: DataSource()

Reimplemented from itk::Object.

otb::ogr::Layer otb::ogr::DataSource::CreateLayer	(	std::string const &	name,
		OGRSpatialReference *	poSpatialRef = `NULL`,
		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:: OGRDataSource::CreateLayer()

Definition at line 262 of file otbOGRDataSourceWrapper.cxx.

References otb::ogr::StringListConverter::to_ogr().

void itk::DataObject::DataHasBeenGenerated ( )

inherited

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

Definition at line 428 of file itkDataObject.cxx.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

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:: OGRDataSource::DeleteLayer()

Definition at line 397 of file otbOGRDataSourceWrapper.cxx.

void itk::DataObject::DisconnectPipeline ( )

inherited

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Definition at line 216 of file itkDataObject.cxx.

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

inline

Definition at line 227 of file otbOGRDataSourceWrapper.h.

References cend().

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

Definition at line 257 of file otbOGRDataSourceWrapper.cxx.

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

Excecutes 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 explicitely 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 OGRDataSource::ReleaseResultSet().

See also:: OGRDataSource::ExecuteSQL()

Definition at line 541 of file otbOGRDataSourceWrapper.cxx.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::DataObject::GetDataReleased ( ) const

inlineinherited

Get the flag indicating the data has been released.

Definition at line 332 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

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.

Definition at line 661 of file otbOGRDataSourceWrapper.cxx.

OGREnvelope otb::ogr::DataSource::GetGlobalExtent	(	bool	force = `false`,
		std::string *	outwkt = `0`
	)		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.

Definition at line 597 of file otbOGRDataSourceWrapper.cxx.

bool itk::DataObject::GetGlobalReleaseDataFlag ( )

staticinherited

Definition at line 189 of file itkDataObject.cxx.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

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 48 of file otbOGRDataSourceWrapper.txx.

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

inline

Definition at line 57 of file otbOGRDataSourceWrapper.txx.

otb::ogr::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.

Definition at line 515 of file otbOGRDataSourceWrapper.cxx.

otb::ogr::Layer const 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 63 of file otbOGRDataSourceWrapper.txx.

otb::ogr::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

Definition at line 490 of file otbOGRDataSourceWrapper.cxx.

otb::ogr::Layer const 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.txx.

otb::ogr::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.

Definition at line 522 of file otbOGRDataSourceWrapper.cxx.

Layer const 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.

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

private

Definition at line 478 of file otbOGRDataSourceWrapper.cxx.

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

private

Definition at line 462 of file otbOGRDataSourceWrapper.cxx.

References otb::ogr::Layer::GetName().

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

Returns the number of layers.

See also:: OGRDataSource::GetLayersCount()

Definition at line 535 of file otbOGRDataSourceWrapper.cxx.

Referenced by DataSource().

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

Definition at line 508 of file otbOGRDataSourceWrapper.cxx.

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

inlineprivate

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

Definition at line 76 of file otbOGRDataSourceWrapper.txx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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

virtual

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

Exceptions:

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

Note:: OGRRegisterAll() is implicitly called on construction.

See also:: DataSource()

Reimplemented from itk::DataObject.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( )

virtualinherited

Referenced by itk::ProcessObject::UpdateOutputInformation().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( )

virtualinherited

SmartPointerForwardReference< ProcessObject > itk::DataObject::GetSource ( void ) const

inherited

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

Definition at line 288 of file itkDataObject.cxx.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const

inherited

Which of the source's outputs corresponds to this data object?

Definition at line 296 of file itkDataObject.cxx.

Referenced by itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion().

unsigned long itk::DataObject::GetUpdateMTime ( ) const

virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

static void itk::DataObject::GlobalReleaseDataFlagOff ( )

inlinestaticinherited

Definition at line 318 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( )

inlinestaticinherited

Definition at line 316 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

virtual

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 OGRDataSource.

Reimplemented from itk::DataObject.

Definition at line 689 of file otbOGRDataSourceWrapper.cxx.

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

Returns whether a capability is avalaible.

Parameters:

[in] capabilityName name of the capability to check.

Exceptions:

None

See also:: OGRDataSource::TestCapability()

Definition at line 694 of file otbOGRDataSourceWrapper.cxx.

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::DataObject::Initialize ( void )

virtualinherited

Restore the data object to its initial state. This means releasing memory.

Definition at line 167 of file itkDataObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

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

private

Definition at line 431 of file otbOGRDataSourceWrapper.cxx.

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

private

Definition at line 445 of file otbOGRDataSourceWrapper.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

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

static

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

Exceptions:

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

Note:: OGRRegisterAll() is implicitly called on construction.

See also:: DataSource()

Reimplemented from itk::Object.

Referenced by otb::LabelImageToVectorDataFilter< TInputImage, TPrecision >::GenerateData(), otb::LabelImageToOGRDataSourceFilter< TInputImage >::GenerateData(), main(), and OpenDataSource().

otb::ogr::DataSource::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 OGRDataSource cannot be opened.

Note:: OGRRegisterAll() is implicitly called on construction

See also:: DataSource(OGRDataSource *)

Definition at line 208 of file otbOGRDataSourceWrapper.cxx.

References DeleteDataSource(), and otb::ogr::Drivers::Init().

otb::ogr::DataSource::Pointer otb::ogr::DataSource::New	(	OGRDataSource *	sourcemode,
		Modes::type	mode = `Modes::Read`
	)

static

Builder from a built OGRDataSource.

Parameters:

[in,out] source OGRDataSource 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(OGRDataSource *)

Definition at line 227 of file otbOGRDataSourceWrapper.cxx.

References itk::SmartPointer< TObjectType >::UnRegister().

OGRDataSource & otb::ogr::DataSource::ogr ( )

inline

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

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

Warning:: You must under no circonstance try to delete the OGRDataSource obtained this way.

Definition at line 41 of file otbOGRDataSourceWrapper.txx.

References m_DataSource.

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

staticprotected

Definition at line 140 of file otbOGRDataSourceWrapper.cxx.

References New().

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 454 of file otbOGRDataSourceWrapper.h.

References otb::ogr::DataSource::boolean::i, and m_DataSource.

virtual void itk::DataObject::PrepareForNewData ( )

inlinevirtualinherited

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 385 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

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

protectedvirtual

Prints self into stream.

Reimplemented from itk::DataObject.

Definition at line 679 of file otbOGRDataSourceWrapper.cxx.

References otb::ogr::Layer::PrintSelf().

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::DataObject::PropagateRequestedRegion ( void )

virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Definition at line 379 of file itkDataObject.cxx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::DataObject::PropagateResetPipeline ( )

protectedvirtualinherited

Propagate a call to ResetPipeline(). Called only from ProcessObject.

Definition at line 367 of file itkDataObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::DataObject::ReleaseData ( )

inherited

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

Definition at line 197 of file itkDataObject.cxx.

virtual void itk::DataObject::ReleaseDataFlagOff ( )

virtualinherited

virtual void itk::DataObject::ReleaseDataFlagOn ( )

virtualinherited

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )

inlinevirtualinherited

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented in itk::ImageBase< VImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PointSet< TPixel, VDimension, TTraits >, and itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.

Definition at line 409 of file itkDataObject.h.

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

Resets current data source with the one in parameter.

Parameters:

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

Exceptions:

None

Postcondition:: Assumes ownership of the source.

Definition at line 49 of file otbOGRDataSourceWrapper.cxx.

Referenced by Clear().

void itk::DataObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 360 of file itkDataObject.cxx.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::DataObject::SetGlobalReleaseDataFlag ( bool val )

staticinherited

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 177 of file itkDataObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::DataObject::SetPipelineMTime ( unsigned long time )

inlineinherited

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 370 of file itkDataObject.h.

Referenced by itk::ProcessObject::UpdateOutputInformation().

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::DataObject::SetReleaseDataFlag ( bool flag )

inlineinherited

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegion ( DataObject * )

inlinevirtualinherited

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 442 of file itkDataObject.h.

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( )

inlinevirtualinherited

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 398 of file itkDataObject.h.

bool itk::DataObject::ShouldIReleaseData ( ) const

inherited

Return flag indicating whether data should be released after use by a filter.

Definition at line 206 of file itkDataObject.cxx.

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()

Definition at line 588 of file otbOGRDataSourceWrapper.cxx.

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

Flushes all changes to disk.

Exceptions:

itd::ExceptionObject in case the flush operation failed.

See also:: OGRDataSource::SyncToDisk()

Definition at line 700 of file otbOGRDataSourceWrapper.cxx.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::DataObject::Update ( void )

virtualinherited

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

Definition at line 340 of file itkDataObject.cxx.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation().

void itk::DataObject::UpdateOutputData ( void )

virtualinherited

Definition at line 410 of file itkDataObject.cxx.

void itk::DataObject::UpdateOutputInformation ( void )

virtualinherited

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

Definition at line 350 of file itkDataObject.cxx.

Referenced by otb::Wrapper::InputVectorDataListParameter::AddVectorData(), and itk::ProcessObject::UpdateOutputInformation().

virtual bool itk::DataObject::VerifyRequestedRegion ( )

inlinevirtualinherited

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 424 of file itkDataObject.h.

Friends And Related Function Documentation

friend class layer_iter

friend

Definition at line 222 of file otbOGRDataSourceWrapper.h.

Member Data Documentation

OGRDataSource* otb::ogr::DataSource::m_DataSource

private

Definition at line 529 of file otbOGRDataSourceWrapper.h.

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

int otb::ogr::DataSource::m_FirstModifiableLayerID

private

Definition at line 531 of file otbOGRDataSourceWrapper.h.

Referenced by DataSource().

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

private

Definition at line 530 of file otbOGRDataSourceWrapper.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Standard macros

Iteration

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation