te::vp::AbstractOperationCapabilities Class Reference

Abstract class used to define the capabilities of the operation, inclusing number of inputs and outputs. More...

#include <AbstractOperation.h>

Public Member Functions

 AbstractOperationCapabilities (const std::string &operationName, std::size_t numberOfInputs, std::size_t numberOfOutputs, const std::string &dataHandlerName, bool snapGeometries=true)
 Destructor. More...
 
std::unique_ptr< AbstractParameterscreateParameters () const
 
const std::string & getDataHandlerName () const
 Checks if the geometries must be snapped to each other before the operation is executed. More...
 
const std::string & getName () const
 Returns TRUE if the operation supports the subdivision of the geometries. FALSE otherwise. More...
 
std::size_t getNumberOfInputs () const
 Returns the number of outputs of the operation. More...
 
std::size_t getNumberOfOutputs () const
 Returns the name of the operation. More...
 
bool getSnapGeometries () const
 Creates the parameters for this operation. If the concrete operation has specific parameters, it must override this class and instantiate the correct parameters. More...
 
virtual ~AbstractOperationCapabilities ()
 Returns the number of inputs of the operation. More...
 

Protected Attributes

std::string m_dataHandlerName
 TRUE if the operation supports the subdivision of the geometries. FALSE otherwise. More...
 
std::size_t m_numberOfInputs
 The number of inputs of the operation. More...
 
std::size_t m_numberOfOutputs
 The number of outputs of the operation. More...
 
std::string m_operationName
 The name of the operation. More...
 
bool m_snapGeometries
 TRUE if the geometries must be snapped to each other before the operation is executed. FALSE otherwise. Default is TRUE. More...
 

Detailed Description

Abstract class used to define the capabilities of the operation, inclusing number of inputs and outputs.

Definition at line 167 of file AbstractOperation.h.

Constructor & Destructor Documentation

◆ AbstractOperationCapabilities()

te::vp::AbstractOperationCapabilities::AbstractOperationCapabilities ( const std::string &  operationName,
std::size_t  numberOfInputs,
std::size_t  numberOfOutputs,
const std::string &  dataHandlerName,
bool  snapGeometries = true 
)

Destructor.

◆ ~AbstractOperationCapabilities()

virtual te::vp::AbstractOperationCapabilities::~AbstractOperationCapabilities ( )
virtual

Returns the number of inputs of the operation.

Member Function Documentation

◆ createParameters()

std::unique_ptr<AbstractParameters> te::vp::AbstractOperationCapabilities::createParameters ( ) const

◆ getDataHandlerName()

const std::string& te::vp::AbstractOperationCapabilities::getDataHandlerName ( ) const

Checks if the geometries must be snapped to each other before the operation is executed.

◆ getName()

const std::string& te::vp::AbstractOperationCapabilities::getName ( ) const

Returns TRUE if the operation supports the subdivision of the geometries. FALSE otherwise.

◆ getNumberOfInputs()

std::size_t te::vp::AbstractOperationCapabilities::getNumberOfInputs ( ) const

Returns the number of outputs of the operation.

◆ getNumberOfOutputs()

std::size_t te::vp::AbstractOperationCapabilities::getNumberOfOutputs ( ) const

Returns the name of the operation.

◆ getSnapGeometries()

bool te::vp::AbstractOperationCapabilities::getSnapGeometries ( ) const

Creates the parameters for this operation. If the concrete operation has specific parameters, it must override this class and instantiate the correct parameters.

Member Data Documentation

◆ m_dataHandlerName

std::string te::vp::AbstractOperationCapabilities::m_dataHandlerName
protected

TRUE if the operation supports the subdivision of the geometries. FALSE otherwise.

Definition at line 198 of file AbstractOperation.h.

◆ m_numberOfInputs

std::size_t te::vp::AbstractOperationCapabilities::m_numberOfInputs
protected

The number of inputs of the operation.

Definition at line 196 of file AbstractOperation.h.

◆ m_numberOfOutputs

std::size_t te::vp::AbstractOperationCapabilities::m_numberOfOutputs
protected

The number of outputs of the operation.

Definition at line 197 of file AbstractOperation.h.

◆ m_operationName

std::string te::vp::AbstractOperationCapabilities::m_operationName
protected

The name of the operation.

Definition at line 195 of file AbstractOperation.h.

◆ m_snapGeometries

bool te::vp::AbstractOperationCapabilities::m_snapGeometries
protected

TRUE if the geometries must be snapped to each other before the operation is executed. FALSE otherwise. Default is TRUE.

Definition at line 199 of file AbstractOperation.h.


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