te::vp::AlgorithmParams Class Reference

#include <AlgorithmParams.h>

Public Member Functions

void addWarning (const std::string &warning, const bool &appendIfExist=false)
 
 AlgorithmParams ()
 
 AlgorithmParams (const std::vector< te::vp::InputParams > &inputParams, te::da::DataSourcePtr outputDataSource, const std::string &outputDataSetName, const int &outputSRID, const std::map< std::string, te::dt::AbstractData *> &specificParams)
 Constructor. More...
 
std::vector< te::vp::InputParamsgetInputParams ()
 
const std::string & getOutputDataSetName ()
 
te::da::DataSourcePtr getOutputDataSource ()
 
const int & getOutputSRID ()
 
const std::map< std::string, te::dt::AbstractData * > & getSpecificParams ()
 
const std::vector< std::string > & getWarnings ()
 
void setInputParams (const std::vector< te::vp::InputParams > &setInputParams)
 
void setOutputDataSetName (const std::string &outputDataSetName)
 
void setOutputDataSource (te::da::DataSourcePtr outputDataSource)
 
void setOutputSRID (const int &outputSRID)
 
void setSpecificParams (const std::map< std::string, te::dt::AbstractData *> &specificParams)
 
 ~AlgorithmParams ()
 Destructor. More...
 

Protected Attributes

std::vector< te::vp::InputParamsm_inputParams
 
std::string m_outputDataSetName
 
te::da::DataSourcePtr m_outputDataSource
 
int m_outputSRID
 
std::map< std::string, te::dt::AbstractData * > m_specificParams
 
std::vector< std::string > m_warnings
 

Detailed Description

Definition at line 51 of file AlgorithmParams.h.

Constructor & Destructor Documentation

◆ AlgorithmParams() [1/2]

te::vp::AlgorithmParams::AlgorithmParams ( )

◆ AlgorithmParams() [2/2]

te::vp::AlgorithmParams::AlgorithmParams ( const std::vector< te::vp::InputParams > &  inputParams,
te::da::DataSourcePtr  outputDataSource,
const std::string &  outputDataSetName,
const int &  outputSRID,
const std::map< std::string, te::dt::AbstractData *> &  specificParams 
)

Constructor.

Parameters
mapwith a DataSetName as a key and a DataSource as a value.
Note
The AlgorithmParams will take the ownership of DataSource.

◆ ~AlgorithmParams()

te::vp::AlgorithmParams::~AlgorithmParams ( )

Destructor.

Member Function Documentation

◆ addWarning()

void te::vp::AlgorithmParams::addWarning ( const std::string &  warning,
const bool &  appendIfExist = false 
)

◆ getInputParams()

std::vector<te::vp::InputParams> te::vp::AlgorithmParams::getInputParams ( )

◆ getOutputDataSetName()

const std::string& te::vp::AlgorithmParams::getOutputDataSetName ( )

◆ getOutputDataSource()

te::da::DataSourcePtr te::vp::AlgorithmParams::getOutputDataSource ( )

◆ getOutputSRID()

const int& te::vp::AlgorithmParams::getOutputSRID ( )

◆ getSpecificParams()

const std::map<std::string, te::dt::AbstractData*>& te::vp::AlgorithmParams::getSpecificParams ( )

◆ getWarnings()

const std::vector<std::string>& te::vp::AlgorithmParams::getWarnings ( )

◆ setInputParams()

void te::vp::AlgorithmParams::setInputParams ( const std::vector< te::vp::InputParams > &  setInputParams)

◆ setOutputDataSetName()

void te::vp::AlgorithmParams::setOutputDataSetName ( const std::string &  outputDataSetName)

◆ setOutputDataSource()

void te::vp::AlgorithmParams::setOutputDataSource ( te::da::DataSourcePtr  outputDataSource)

◆ setOutputSRID()

void te::vp::AlgorithmParams::setOutputSRID ( const int &  outputSRID)

◆ setSpecificParams()

void te::vp::AlgorithmParams::setSpecificParams ( const std::map< std::string, te::dt::AbstractData *> &  specificParams)

Member Data Documentation

◆ m_inputParams

std::vector<te::vp::InputParams> te::vp::AlgorithmParams::m_inputParams
protected

Definition at line 105 of file AlgorithmParams.h.

◆ m_outputDataSetName

std::string te::vp::AlgorithmParams::m_outputDataSetName
protected

Definition at line 108 of file AlgorithmParams.h.

◆ m_outputDataSource

te::da::DataSourcePtr te::vp::AlgorithmParams::m_outputDataSource
protected

Definition at line 107 of file AlgorithmParams.h.

◆ m_outputSRID

int te::vp::AlgorithmParams::m_outputSRID
protected

Definition at line 109 of file AlgorithmParams.h.

◆ m_specificParams

std::map<std::string, te::dt::AbstractData*> te::vp::AlgorithmParams::m_specificParams
protected

Definition at line 111 of file AlgorithmParams.h.

◆ m_warnings

std::vector<std::string> te::vp::AlgorithmParams::m_warnings
protected

Definition at line 113 of file AlgorithmParams.h.


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