OpenIndy-Core  0.2.0.43
oi::Function Class Reference

The Function class. More...

#include <function.h>

Inheritance diagram for oi::Function:
oi::ConstructFunction oi::FitFunction oi::GenerateFeatureFunction oi::GeodeticFunction oi::ObjectTransformation oi::SystemTransformation

Signals

void sendMessage (const QString &msg, const MessageTypes &msgType, const MessageDestinations &msgDest=eConsoleMessage)
 
void inputElementsChanged ()
 
void scalarInputParametersChanged ()
 

Public Member Functions

 Function (QObject *parent=0)
 Function::Function. More...
 
virtual ~Function ()
 Function::~Function. More...
 
virtual void init ()
 Function::init. More...
 
bool exec (const QPointer< FeatureWrapper > &feature)
 Function::exec. More...
 
const QList< NeededElement > & getNeededElements () const
 Function::getNeededElements. More...
 
const QList< FeatureTypes > & getApplicableFor () const
 Function::getApplicableFor. More...
 
const PluginMetaDatagetMetaData () const
 Function::getMetaData. More...
 
const QMap< QString, int > & getIntegerParameter () const
 Function::getIntegerParameter. More...
 
const QMap< QString, double > & getDoubleParameter () const
 Function::getDoubleParameter. More...
 
const QMultiMap< QString, QString > & getStringParameter () const
 Function::getStringParameter. More...
 
void setScalarInputParams (const ScalarInputParams &params)
 Function::setScalarInputParams. More...
 
const ScalarInputParamsgetScalarInputParams ()
 Function::getScalarInputParams. More...
 
const QList< FixedParameter > & getFixedParameters () const
 Function::getFixedParameters. More...
 
void fixParameter (const FixedParameter &parameter)
 Function::fixParameter. More...
 
void unfixParameter (const GeometryParameters &parameter)
 Function::unfixParameter. More...
 
void unfixAllParameters ()
 Function::unfixAllParameters. More...
 
const QStringList & getResultProtocol () const
 Function::getResultProtocol. More...
 
const StatisticgetStatistic () const
 Function::getStatistic. More...
 
const int & getId () const
 Function::getId. More...
 
const QMap< int, QList< InputElement > > & getInputElements () const
 Function::getInputElements. More...
 
InputElement getInputElement (const int &id) const
 Function::getInputElement Returns the InputElement with the specified id or an empty InputElement. More...
 
InputElement getInputElement (const int &id, const int &position) const
 Function::getInputElement Returns the InputElement with the specified id at the specified position. More...
 
bool hasInputElement (const int &id) const
 Function::hasInputElement Check wether the function contains the specified InputElement. More...
 
void addInputElement (const InputElement &element, const int &position)
 Function::addInputElement. More...
 
void removeInputElement (const int &id, const int &position)
 Function::removeInputElement. More...
 
void removeInputElement (const int &id)
 Function::removeInputElement. More...
 
void replaceInputElement (const InputElement &element, const int &position)
 Function::replaceInputElement. More...
 
bool getIsUsed (const int &position, const int &id)
 Function::getIsUsed. More...
 
bool getShouldBeUsed (const int &position, const int &id)
 Function::getShouldBeUsed. More...
 
void setShouldBeUsed (const int &position, const int &id, const bool &state)
 Function::setShouldBeUsed. More...
 
virtual void clear ()
 Function::clear. More...
 
virtual void clearResults ()
 Function::clearResults. More...
 
QDomElement toOpenIndyXML (QDomDocument &xmlDoc) const
 Function::toOpenIndyXML. More...
 
bool fromOpenIndyXML (QDomElement &xmlElem)
 Function::fromOpenIndyXML. More...
 

Protected Member Functions

virtual bool exec (Station &station)
 Function::exec. More...
 
virtual bool exec (CoordinateSystem &coordinateSystem)
 Function::exec. More...
 
virtual bool exec (TrafoParam &trafoParam)
 Function::exec. More...
 
virtual bool exec (Circle &circle)
 Function::exec. More...
 
virtual bool exec (Cone &cone)
 Function::exec. More...
 
virtual bool exec (Cylinder &cylinder)
 Function::exec. More...
 
virtual bool exec (Ellipse &ellipse)
 Function::exec. More...
 
virtual bool exec (Ellipsoid &ellipsoid)
 Function::exec. More...
 
virtual bool exec (Hyperboloid &hyperboloid)
 Function::exec. More...
 
virtual bool exec (Line &line)
 Function::exec. More...
 
virtual bool exec (Nurbs &nurbs)
 Function::exec. More...
 
virtual bool exec (Paraboloid &paraboloid)
 Function::exec. More...
 
virtual bool exec (Plane &plane)
 Function::exec. More...
 
virtual bool exec (Point &point)
 Function::exec. More...
 
virtual bool exec (PointCloud &pointCloud)
 Function::exec. More...
 
virtual bool exec (ScalarEntityAngle &angle)
 Function::exec. More...
 
virtual bool exec (ScalarEntityDistance &distance)
 Function::exec. More...
 
virtual bool exec (ScalarEntityMeasurementSeries &measurementSeries)
 Function::exec. More...
 
virtual bool exec (ScalarEntityTemperature &temperature)
 Function::exec. More...
 
virtual bool exec (SlottedHole &slottedHole)
 Function::exec. More...
 
virtual bool exec (Sphere &sphere)
 Function::exec. More...
 
virtual bool exec (Torus &torus)
 Function::exec. More...
 
void setIsUsed (const int &position, const int &id, const bool &state)
 Function::setIsUsed. More...
 

Protected Attributes

QList< NeededElementneededElements
 
QList< FeatureTypesapplicableFor
 
PluginMetaData metaData
 
QMap< QString, int > integerParameters
 
QMap< QString, double > doubleParameters
 
QMultiMap< QString, QString > stringParameters
 
ScalarInputParams scalarInputParams
 
QList< FixedParameterfixedParameters
 
QStringList resultProtocol
 
int id
 
Statistic statistic
 
QMap< int, QList< InputElement > > inputElements
 

Friends

class Feature
 

Detailed Description

The Function class.

Constructor & Destructor Documentation

Function::Function ( QObject *  parent = 0)

Function::Function.

Parameters
parent
Function::~Function ( )
virtual

Member Function Documentation

void Function::addInputElement ( const InputElement element,
const int &  position 
)

Function::addInputElement.

Parameters
element
position
void Function::clear ( )
virtual
void Function::clearResults ( )
virtual
bool Function::exec ( const QPointer< FeatureWrapper > &  feature)

Function::exec.

Parameters
feature
Returns
bool Function::exec ( Station station)
protectedvirtual
bool Function::exec ( CoordinateSystem coordinateSystem)
protectedvirtual
bool Function::exec ( TrafoParam trafoParam)
protectedvirtual

Function::exec.

Parameters
trafoParam
Returns

Reimplemented in oi::FitFunction, oi::ConstructFunction, and oi::GeodeticFunction.

bool Function::exec ( Circle circle)
protectedvirtual

Function::exec.

Parameters
circle
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Cone cone)
protectedvirtual

Function::exec.

Parameters
cone
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Cylinder cylinder)
protectedvirtual

Function::exec.

Parameters
cylinder
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Ellipse ellipse)
protectedvirtual

Function::exec.

Parameters
ellipse
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Ellipsoid ellipsoid)
protectedvirtual

Function::exec.

Parameters
ellipsoid
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Hyperboloid hyperboloid)
protectedvirtual

Function::exec.

Parameters
hyperboloid
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Line line)
protectedvirtual

Function::exec.

Parameters
line
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Nurbs nurbs)
protectedvirtual

Function::exec.

Parameters
nurbs
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Paraboloid paraboloid)
protectedvirtual

Function::exec.

Parameters
paraboloid
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Plane plane)
protectedvirtual

Function::exec.

Parameters
plane
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Point point)
protectedvirtual

Function::exec.

Parameters
point
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( PointCloud pointCloud)
protectedvirtual

Function::exec.

Parameters
pointCloud
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( ScalarEntityAngle angle)
protectedvirtual

Function::exec.

Parameters
angle
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( ScalarEntityDistance distance)
protectedvirtual

Function::exec.

Parameters
distance
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( ScalarEntityMeasurementSeries measurementSeries)
protectedvirtual

Function::exec.

Parameters
measurementSeries
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( ScalarEntityTemperature temperature)
protectedvirtual

Function::exec.

Parameters
temperature
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( SlottedHole slottedHole)
protectedvirtual

Function::exec.

Parameters
slottedHole
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Sphere sphere)
protectedvirtual

Function::exec.

Parameters
sphere
Returns

Reimplemented in oi::SystemTransformation.

bool Function::exec ( Torus torus)
protectedvirtual

Function::exec.

Parameters
torus
Returns

Reimplemented in oi::SystemTransformation.

void Function::fixParameter ( const FixedParameter parameter)

Function::fixParameter.

Parameters
parameter
bool Function::fromOpenIndyXML ( QDomElement &  xmlElem)

Function::fromOpenIndyXML.

Parameters
xmlElem
Returns
const QList< FeatureTypes > & Function::getApplicableFor ( ) const
const QMap< QString, double > & Function::getDoubleParameter ( ) const
const QList< FixedParameter > & Function::getFixedParameters ( ) const
const int & Function::getId ( ) const

Function::getId.

Returns
InputElement Function::getInputElement ( const int &  id) const

Function::getInputElement Returns the InputElement with the specified id or an empty InputElement.

Parameters
id
Returns
InputElement Function::getInputElement ( const int &  id,
const int &  position 
) const

Function::getInputElement Returns the InputElement with the specified id at the specified position.

Parameters
id
position
Returns
const QMap< int, QList< InputElement > > & Function::getInputElements ( ) const
const QMap< QString, int > & Function::getIntegerParameter ( ) const
bool Function::getIsUsed ( const int &  position,
const int &  id 
)

Function::getIsUsed.

Parameters
position
id
Returns
const PluginMetaData & Function::getMetaData ( ) const
const QList< NeededElement > & Function::getNeededElements ( ) const
const QStringList & Function::getResultProtocol ( ) const
const ScalarInputParams & Function::getScalarInputParams ( )
bool Function::getShouldBeUsed ( const int &  position,
const int &  id 
)

Function::getShouldBeUsed.

Parameters
position
id
Returns
const Statistic & Function::getStatistic ( ) const
const QMultiMap< QString, QString > & Function::getStringParameter ( ) const
bool Function::hasInputElement ( const int &  id) const

Function::hasInputElement Check wether the function contains the specified InputElement.

Parameters
id
Returns
void Function::init ( )
virtual
void oi::Function::inputElementsChanged ( )
signal
void Function::removeInputElement ( const int &  id,
const int &  position 
)

Function::removeInputElement.

Parameters
id
position
void Function::removeInputElement ( const int &  id)
void Function::replaceInputElement ( const InputElement element,
const int &  position 
)

Function::replaceInputElement.

Parameters
element
position
void oi::Function::scalarInputParametersChanged ( )
signal
void oi::Function::sendMessage ( const QString &  msg,
const MessageTypes msgType,
const MessageDestinations msgDest = eConsoleMessage 
)
signal
void Function::setIsUsed ( const int &  position,
const int &  id,
const bool &  state 
)
protected

Function::setIsUsed.

Parameters
position
id
state
void Function::setScalarInputParams ( const ScalarInputParams params)

Function::setScalarInputParams.

Parameters
params
void Function::setShouldBeUsed ( const int &  position,
const int &  id,
const bool &  state 
)

Function::setShouldBeUsed.

Parameters
position
id
state
QDomElement Function::toOpenIndyXML ( QDomDocument &  xmlDoc) const

Function::toOpenIndyXML.

Parameters
xmlDoc
Returns
void Function::unfixAllParameters ( )
void Function::unfixParameter ( const GeometryParameters parameter)

Function::unfixParameter.

Parameters
parameter

Friends And Related Function Documentation

friend class Feature
friend

Member Data Documentation

QList<FeatureTypes> oi::Function::applicableFor
protected
QMap<QString, double> oi::Function::doubleParameters
protected
QList<FixedParameter> oi::Function::fixedParameters
protected
int oi::Function::id
protected
QMap<int, QList<InputElement> > oi::Function::inputElements
protected
QMap<QString, int> oi::Function::integerParameters
protected
PluginMetaData oi::Function::metaData
protected
QList<NeededElement> oi::Function::neededElements
protected
QStringList oi::Function::resultProtocol
protected
ScalarInputParams oi::Function::scalarInputParams
protected
Statistic oi::Function::statistic
protected
QMultiMap<QString, QString> oi::Function::stringParameters
protected

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