A feeder from an input directory name. More...

#include <FeedersRaster.h>

Inheritance diagram for te::rp::FeederConstRasterDirectory:

Public Member Functions
void	applyGeometryRestriction (const te::gm::Geometry &restrictionGeom)
	Apply a new geometry intersect restriction selecting only those rasters intersecting the given geometry. More...

	FeederConstRasterDirectory (const std::string &directoryName, const bool recursive, const std::string &rType, const bool sortFileNames, const std::vector< std::string > &fileExtensions)
	Constructor from an input directory name. More...

	FeederConstRasterDirectory (const std::string &directoryName, const bool recursive, const std::string &rType, const bool sortFileNames, const std::vector< std::string > &fileExtensions, te::gm::Geometry const *const restrictionGeomPtr, const bool ignoreInvalidRasterFiles)
	Constructor from an input directory name with a restriction geometry. More...

te::rst::Raster const *	getCurrentObj () const
	Return the current sequence object. More...

unsigned int	getCurrentOffset () const
	Return the index of the current object. More...

const std::string &	getCurrentRasterFileName ()
	Returns the current raster file name. More...

unsigned int	getObjsCount () const
	Return the total number of feeder objects. More...

void	getRasterNames (std::vector< std::string > &rasterNames)
	Returns a vector of all rasters names. More...

bool	moveNext ()
	Advances to the next sequence obeject. More...

bool	moveTo (const unsigned int index)
	Jump to the given object index. More...

void	reset ()
	Reset the feeder to the first position (subsequent accesses will start from the first sequence obejct). More...

	~FeederConstRasterDirectory ()

Protected Member Functions
	FeederConstRasterDirectory ()

bool	initialize (const std::string &directoryName, const bool recursive, const std::string &rType, const bool sortFileNames, const std::vector< std::string > &fileExtensions, te::gm::Geometry const *const restrictionGeomPtr, const bool ignoreInvalidRasterFiles)
	Initialize this instance. More...

Protected Attributes
std::vector< std::string >	m_allRasterFileNames

std::vector< te::gm::Polygon >	m_allRastersBoundingBoxes

std::unique_ptr< te::rst::Raster >	m_currentRasterPtr

bool	m_ignoreInvalidRasterFiles
	If true, invalid raster files will be ignored. More...

std::unique_ptr< te::gm::Geometry >	m_restrictionGeomPtr

std::string	m_rType

std::vector< unsigned int >::size_type	m_selectedRasterIndexesOffset

std::vector< unsigned int >	m_selectedRastersIndexes

Detailed Description

A feeder from an input directory name.

Definition at line 190 of file FeedersRaster.h.

Constructor & Destructor Documentation

◆ FeederConstRasterDirectory() [1/3]

te::rp::FeederConstRasterDirectory::FeederConstRasterDirectory	(	const std::string &	directoryName,
		const bool	recursive,
		const std::string &	rType,
		const bool	sortFileNames,
		const std::vector< std::string > &	fileExtensions
	)

Constructor from an input directory name.

Parameters

directoryName	The directory full path name.
recursive	true if a recursive search must be performed.
rType	The name of the specific driver to instantiate each raster ( See te::rst::RasterFactory dictionary for valid registered values ).
sortFileNames	If true, the file names will be sorted.
fileExtensions	The file extensions filter (example: ".tif"), or an empty vector if all extensions must be accepted.

◆ FeederConstRasterDirectory() [2/3]

te::rp::FeederConstRasterDirectory::FeederConstRasterDirectory	(	const std::string &	directoryName,
		const bool	recursive,
		const std::string &	rType,
		const bool	sortFileNames,
		const std::vector< std::string > &	fileExtensions,
		te::gm::Geometry const *const	restrictionGeomPtr,
		const bool	ignoreInvalidRasterFiles
	)

Constructor from an input directory name with a restriction geometry.

Parameters

directoryName	The directory full path name.
recursive	true if a recursive search must be performed.
rType	The name of the specific driver to instantiate each raster.
sortFileNames	If true, the file names will be sorted.
fileExtensions	The file extensions filter (example: ".tif"), or an empty vector if all extensions must be accepted.
restrictionGeomPtr	A pointer to a restriction geometry (only rasters intercepting this geomtry will be considered) or a null pointer if there is no restriction.
ignoreInvalidRasterFiles	If true, invalid raster files will be ignored.

◆ ~FeederConstRasterDirectory()

te::rp::FeederConstRasterDirectory::~FeederConstRasterDirectory ( )

◆ FeederConstRasterDirectory() [3/3]

te::rp::FeederConstRasterDirectory::FeederConstRasterDirectory ( )

protected

Member Function Documentation

◆ applyGeometryRestriction()

void te::rp::FeederConstRasterDirectory::applyGeometryRestriction ( const te::gm::Geometry & restrictionGeom )

Apply a new geometry intersect restriction selecting only those rasters intersecting the given geometry.

Parameters

restrictionGeom The new restrigion geometry.

◆ getCurrentObj()

te::rst::Raster const* te::rp::FeederConstRasterDirectory::getCurrentObj ( ) const

virtual

Return the current sequence object.

Returns: A pointer to the current object or a null pointer if there are no object to return.

Implements te::rp::FeederConstRaster.

◆ getCurrentOffset()

unsigned int te::rp::FeederConstRasterDirectory::getCurrentOffset ( ) const

virtual

Return the index of the current object.

Returns: The index of the current object.

Implements te::rp::FeederConstRaster.

◆ getCurrentRasterFileName()

const std::string& te::rp::FeederConstRasterDirectory::getCurrentRasterFileName ( )

Returns the current raster file name.

Returns: Returns the current raster file name.

◆ getObjsCount()

unsigned int te::rp::FeederConstRasterDirectory::getObjsCount ( ) const

virtual

Return the total number of feeder objects.

Returns: The total number of feeder objects.

Implements te::rp::FeederConstRaster.

◆ getRasterNames()

void te::rp::FeederConstRaster::getRasterNames ( std::vector< std::string > & rasterNames )

inherited

Returns a vector of all rasters names.

Parameters

uriStrings A vector of all rasters names.

◆ initialize()

bool te::rp::FeederConstRasterDirectory::initialize	(	const std::string &	directoryName,
		const bool	recursive,
		const std::string &	rType,
		const bool	sortFileNames,
		const std::vector< std::string > &	fileExtensions,
		te::gm::Geometry const *const	restrictionGeomPtr,
		const bool	ignoreInvalidRasterFiles
	)

protected

Initialize this instance.

Parameters

directoryName	The directory full path name.
recursive	true if a recursive search must be performed.
rType	The name of the specific driver to instantiate each raster.
sortFileNames	If true, the file names will be sorted.
fileExtensions	The file extensions filter (example: ".tif"), or an empty vector if all extensions must be accepted.
restrictionGeomPtr	A pointer to a restriction geometry (only rasters intercepting this geomtry will be considered) or a null pointer if there is no restriction.
ignoreInvalidRasterFiles	If true, invalid raster files will be ignored.

◆ moveNext()

bool te::rp::FeederConstRasterDirectory::moveNext ( )

virtual

Advances to the next sequence obeject.

Returns: true if the advance was completed or false if the objects sequence end was reached.

Note: This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

◆ moveTo()

bool te::rp::FeederConstRasterDirectory::moveTo ( const unsigned int index )

virtual

Jump to the given object index.

Returns: true if the jump was completed or false on errors.

Note: This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

◆ reset()

void te::rp::FeederConstRasterDirectory::reset ( )

virtual

Reset the feeder to the first position (subsequent accesses will start from the first sequence obejct).

Note: This method can invalidate any pointer returned by getCurrentObj.

Implements te::rp::FeederConstRaster.

Member Data Documentation

◆ m_allRasterFileNames

std::vector< std::string > te::rp::FeederConstRasterDirectory::m_allRasterFileNames

protected

Definition at line 254 of file FeedersRaster.h.

◆ m_allRastersBoundingBoxes

std::vector< te::gm::Polygon > te::rp::FeederConstRasterDirectory::m_allRastersBoundingBoxes

protected

Definition at line 255 of file FeedersRaster.h.

◆ m_currentRasterPtr

std::unique_ptr< te::rst::Raster > te::rp::FeederConstRasterDirectory::m_currentRasterPtr

protected

Definition at line 256 of file FeedersRaster.h.

◆ m_ignoreInvalidRasterFiles

bool te::rp::FeederConstRasterDirectory::m_ignoreInvalidRasterFiles

protected

If true, invalid raster files will be ignored.

Definition at line 250 of file FeedersRaster.h.

◆ m_restrictionGeomPtr

std::unique_ptr< te::gm::Geometry > te::rp::FeederConstRasterDirectory::m_restrictionGeomPtr

protected

Definition at line 257 of file FeedersRaster.h.

◆ m_rType

std::string te::rp::FeederConstRasterDirectory::m_rType

protected

Definition at line 251 of file FeedersRaster.h.

◆ m_selectedRasterIndexesOffset

std::vector< unsigned int >::size_type te::rp::FeederConstRasterDirectory::m_selectedRasterIndexesOffset

protected

Definition at line 253 of file FeedersRaster.h.

◆ m_selectedRastersIndexes

std::vector< unsigned int > te::rp::FeederConstRasterDirectory::m_selectedRastersIndexes

protected

Definition at line 252 of file FeedersRaster.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/rp/FeedersRaster.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FeederConstRasterDirectory() [1/3]

◆ FeederConstRasterDirectory() [2/3]

◆ ~FeederConstRasterDirectory()

◆ FeederConstRasterDirectory() [3/3]

Member Function Documentation

◆ applyGeometryRestriction()

◆ getCurrentObj()

◆ getCurrentOffset()

◆ getCurrentRasterFileName()

◆ getObjsCount()

◆ getRasterNames()

◆ initialize()

◆ moveNext()

◆ moveTo()

◆ reset()

Member Data Documentation

◆ m_allRasterFileNames

◆ m_allRastersBoundingBoxes

◆ m_currentRasterPtr

◆ m_ignoreInvalidRasterFiles

◆ m_restrictionGeomPtr

◆ m_rType

◆ m_selectedRasterIndexesOffset

◆ m_selectedRastersIndexes