te::cl::ROISet Class Reference

A ROISet is a set of ROI's. More...

#include <ROISet.h>

Public Member Functions
void	addROI (te::cl::ROI *roi)
	Add a new ROI to this set. More...
void	exportToFile (std::string fileName, int srid)
	Export the ROISet to a shapefile. More...
te::cl::ROI *	getROI (std::string label)
	Gets a ROI from this set. More...
std::map< std::string, te::cl::ROI * > &	getROISet ()
	Get the roi set map. More...
void	removeROI (std::string label)
	Removes a ROI from this set. More...
	ROISet ()
	Default constructor. More...
virtual	~ROISet ()
	Virtual destructor. More...

Static Public Member Functions
static te::cl::ROISet *	createROISet (std::auto_ptr< te::da::DataSet > ds)
	Imports the ROISet from a dataset. More...

Protected Member Functions
std::auto_ptr< te::da::DataSet >	getDataSet (int srid)
	Creates a dataset that with the roi set information. More...
std::auto_ptr< te::da::DataSetType >	getDataSetType (int srid)
	Creates a dataset type that defines a roi. More...

Private Attributes
std::map< std::string, te::cl::ROI * >	m_roiMap
	The map of ROI's. More...

Detailed Description

A ROISet is a set of ROI's.

See also

ROI

Definition at line 53 of file ROISet.h.

Constructor & Destructor Documentation

te::cl::ROISet::ROISet

(

)

Default constructor.

virtual te::cl::ROISet::~ROISet ( )

virtual

Virtual destructor.

Member Function Documentation

void te::cl::ROISet::addROI

(

te::cl::ROI *

roi

)

Add a new ROI to this set.

Parameters

roi	A pointer to a ROI object.

static te::cl::ROISet* te::cl::ROISet::createROISet ( std::auto_ptr< te::da::DataSet >  ds )

static

Imports the ROISet from a dataset.

Parameters

ds	The dataset with the ROISet information

Returns

If the dataset has a valid ROISet information, a valid ROISet pointer will be returned, in other case, a NULL pointer will be returned.

void te::cl::ROISet::exportToFile	(	std::string	fileName,
		int	srid
	)

Export the ROISet to a shapefile.

Parameters

fileName	The file name path.
srid	The spatial reference system used to export the ROI's.

std::auto_ptr<te::da::DataSet> te::cl::ROISet::getDataSet ( int  srid )

protected

Creates a dataset that with the roi set information.

std::auto_ptr<te::da::DataSetType> te::cl::ROISet::getDataSetType ( int  srid )

protected

Creates a dataset type that defines a roi.

te::cl::ROI* te::cl::ROISet::getROI

(

std::string

label

)

Gets a ROI from this set.

Parameters

label

The label of the ROI to be selected.

std::map<std::string, te::cl::ROI*>& te::cl::ROISet::getROISet

(

)

Get the roi set map.

void te::cl::ROISet::removeROI

(

std::string

label

)

Removes a ROI from this set.

Parameters

label

The label of the ROI to be removed.

Member Data Documentation

std::map<std::string, te::cl::ROI*> te::cl::ROISet::m_roiMap

private

The map of ROI's.

Definition at line 118 of file ROISet.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/classification/ROISet.h