Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::sa::SamplePointsGeneratorAbstract Class Referenceabstract

Virtual class to generate samples points. More...

#include <SamplePointsGeneratorAbstract.h>

Inheritance diagram for te::sa::SamplePointsGeneratorAbstract:
te::sa::SamplePointsGeneratorRandom te::sa::SamplePointsGeneratorStratified

Public Member Functions

void execute ()
 Function to execute the kernel operation. More...
 
 SamplePointsGeneratorAbstract ()
 Default constructor. More...
 
void setEnvelope (te::gm::Envelope env)
 
void setOutputDataSetName (std::string dataSetName)
 
void setOutputDataSource (te::da::DataSourcePtr ds)
 
void setSRID (int srid)
 
virtual ~SamplePointsGeneratorAbstract ()
 Virtual destructor. More...
 

Protected Member Functions

virtual std::unique_ptr< te::da::DataSetType > createDataSetType ()=0
 
virtual std::unique_ptr< te::mem::DataSet > generateSamples (te::da::DataSetType *dsType)=0
 
te::gm::Point * getPoint (const te::gm::Envelope *env)
 
void saveDataSet (te::mem::DataSet *dataSet, te::da::DataSetType *dsType)
 

Protected Attributes

boost::random::uniform_real_distribution m_distReal
 
te::da::DataSourcePtr m_ds
 Pointer to the output datasource. More...
 
te::gm::Envelope m_env
 Attribute used to restrict the area to generate the samples. More...
 
boost::random::mt19937 m_gen
 
std::string m_outputDataSetName
 Attribute that defines the output dataset name. More...
 
int m_srid
 Attribute with spatial reference information. More...
 
te::sa::SamplePointsGeneratorType m_type
 Generator Type. More...
 

Detailed Description

Virtual class to generate samples points.

Definition at line 59 of file SamplePointsGeneratorAbstract.h.

Constructor & Destructor Documentation

◆ SamplePointsGeneratorAbstract()

te::sa::SamplePointsGeneratorAbstract::SamplePointsGeneratorAbstract ( )

Default constructor.

◆ ~SamplePointsGeneratorAbstract()

virtual te::sa::SamplePointsGeneratorAbstract::~SamplePointsGeneratorAbstract ( )
virtual

Virtual destructor.

Member Function Documentation

◆ createDataSetType()

virtual std::unique_ptr<te::da::DataSetType> te::sa::SamplePointsGeneratorAbstract::createDataSetType ( )
protectedpure virtual

Function used to create the output dataset type

Implemented in te::sa::SamplePointsGeneratorStratified, and te::sa::SamplePointsGeneratorRandom.

◆ execute()

void te::sa::SamplePointsGeneratorAbstract::execute ( )

Function to execute the kernel operation.

◆ generateSamples()

virtual std::unique_ptr<te::mem::DataSet> te::sa::SamplePointsGeneratorAbstract::generateSamples ( te::da::DataSetType *  dsType)
protectedpure virtual

Function used to create the output data

Implemented in te::sa::SamplePointsGeneratorStratified, and te::sa::SamplePointsGeneratorRandom.

◆ getPoint()

te::gm::Point* te::sa::SamplePointsGeneratorAbstract::getPoint ( const te::gm::Envelope *  env)
protected

Function used to generate a randon point inside a defined envelope

◆ saveDataSet()

void te::sa::SamplePointsGeneratorAbstract::saveDataSet ( te::mem::DataSet *  dataSet,
te::da::DataSetType *  dsType 
)
protected

Function used to save the output dataset

◆ setEnvelope()

void te::sa::SamplePointsGeneratorAbstract::setEnvelope ( te::gm::Envelope  env)

Function used to set the envelope parameter

◆ setOutputDataSetName()

void te::sa::SamplePointsGeneratorAbstract::setOutputDataSetName ( std::string  dataSetName)

Function used to set the output dataset name parameter

◆ setOutputDataSource()

void te::sa::SamplePointsGeneratorAbstract::setOutputDataSource ( te::da::DataSourcePtr  ds)

Function used to set the output data source parameter

◆ setSRID()

void te::sa::SamplePointsGeneratorAbstract::setSRID ( int  srid)

Function used to set the envelope parameter

Member Data Documentation

◆ m_distReal

boost::random::uniform_real_distribution te::sa::SamplePointsGeneratorAbstract::m_distReal
protected

Definition at line 114 of file SamplePointsGeneratorAbstract.h.

◆ m_ds

te::da::DataSourcePtr te::sa::SamplePointsGeneratorAbstract::m_ds
protected

Pointer to the output datasource.

Definition at line 106 of file SamplePointsGeneratorAbstract.h.

◆ m_env

te::gm::Envelope te::sa::SamplePointsGeneratorAbstract::m_env
protected

Attribute used to restrict the area to generate the samples.

Definition at line 104 of file SamplePointsGeneratorAbstract.h.

◆ m_gen

boost::random::mt19937 te::sa::SamplePointsGeneratorAbstract::m_gen
protected

Definition at line 112 of file SamplePointsGeneratorAbstract.h.

◆ m_outputDataSetName

std::string te::sa::SamplePointsGeneratorAbstract::m_outputDataSetName
protected

Attribute that defines the output dataset name.

Definition at line 108 of file SamplePointsGeneratorAbstract.h.

◆ m_srid

int te::sa::SamplePointsGeneratorAbstract::m_srid
protected

Attribute with spatial reference information.

Definition at line 102 of file SamplePointsGeneratorAbstract.h.

◆ m_type

te::sa::SamplePointsGeneratorType te::sa::SamplePointsGeneratorAbstract::m_type
protected

Generator Type.

Definition at line 110 of file SamplePointsGeneratorAbstract.h.

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