tigl::generated::CPACSApproximationSettings Class Reference

#include <CPACSApproximationSettings.h>

Public Member Functions
TIGL_EXPORT	CPACSApproximationSettings (CCPACSCurvePointListXYZ *parent)
virtual TIGL_EXPORT const boost::optional< int > &	GetControlPointNumber_choice1 () const
virtual TIGL_EXPORT const boost::optional< std::string > &	GetErrorComputationMethod () const
virtual TIGL_EXPORT boost::optional< CCPACSStringVector > &	GetInterpolatedPointsIndices ()
virtual TIGL_EXPORT const boost::optional< CCPACSStringVector > &	GetInterpolatedPointsIndices () const
virtual TIGL_EXPORT CCPACSStringVector &	GetInterpolatedPointsIndices (CreateIfNotExistsTag)
virtual TIGL_EXPORT const boost::optional< double > &	GetMaximumError_choice2 () const
virtual TIGL_EXPORT CTiglUIDObject *	GetNextUIDParent ()
virtual TIGL_EXPORT const CTiglUIDObject *	GetNextUIDParent () const
TIGL_EXPORT CCPACSCurvePointListXYZ *	GetParent ()
TIGL_EXPORT const CCPACSCurvePointListXYZ *	GetParent () const
virtual TIGL_EXPORT void	ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
virtual TIGL_EXPORT void	RemoveInterpolatedPointsIndices ()
virtual TIGL_EXPORT void	SetControlPointNumber_choice1 (const boost::optional< int > &value)
virtual TIGL_EXPORT void	SetErrorComputationMethod (const boost::optional< std::string > &value)
virtual TIGL_EXPORT void	SetMaximumError_choice2 (const boost::optional< double > &value)
TIGL_EXPORT bool	ValidateChoices () const
virtual TIGL_EXPORT void	WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
virtual TIGL_EXPORT	~CPACSApproximationSettings ()

Protected Attributes
boost::optional< int >	m_controlPointNumber_choice1
	Defines the number of control points that should be used for approximating the given points with a B-spline curve. The minimal value is 4.
boost::optional< std::string >	m_errorComputationMethod
	Here, the approximation error's computation method can be chosen. The error is computed between the defined points (A) and their respective projections on the approximated curve (B). By default, this error is computed as the root mean square error of the distances between (A) and (B). In the following, the currently allowed entries are listed together with their meaning (-> respective computation method):
boost::optional< CCPACSStringVector >	m_interpolatedPointsIndices
	Index list of points that should still be interpolated. Each index is in the range [1, npoints].
boost::optional< double >	m_maximumError_choice2
	Instead of specifying the number of control points, the positive upper bound for the error of the approximation is provided. The number of control points is increased automatically until the approximation error lies below the given maximum approximation error.
CCPACSCurvePointListXYZ *	m_parent

Private Member Functions
	CPACSApproximationSettings (const CPACSApproximationSettings &)=delete
	CPACSApproximationSettings (CPACSApproximationSettings &&)=delete
CPACSApproximationSettings &	operator= (const CPACSApproximationSettings &)=delete
CPACSApproximationSettings &	operator= (CPACSApproximationSettings &&)=delete

Constructor & Destructor Documentation

CPACSApproximationSettings() [1/3]

TIGL_EXPORT tigl::generated::CPACSApproximationSettings::CPACSApproximationSettings

(

CCPACSCurvePointListXYZ *

parent

)

~CPACSApproximationSettings()

virtual TIGL_EXPORT tigl::generated::CPACSApproximationSettings::~CPACSApproximationSettings ( )

virtual

CPACSApproximationSettings() [2/3]

tigl::generated::CPACSApproximationSettings::CPACSApproximationSettings ( const CPACSApproximationSettings & )

privatedelete

CPACSApproximationSettings() [3/3]

tigl::generated::CPACSApproximationSettings::CPACSApproximationSettings ( CPACSApproximationSettings && )

privatedelete

Member Function Documentation

GetControlPointNumber_choice1()

virtual TIGL_EXPORT const boost::optional< int > & tigl::generated::CPACSApproximationSettings::GetControlPointNumber_choice1 ( ) const

virtual

GetErrorComputationMethod()

virtual TIGL_EXPORT const boost::optional< std::string > & tigl::generated::CPACSApproximationSettings::GetErrorComputationMethod ( ) const

virtual

GetInterpolatedPointsIndices() [1/3]

virtual TIGL_EXPORT boost::optional< CCPACSStringVector > & tigl::generated::CPACSApproximationSettings::GetInterpolatedPointsIndices ( )

virtual

GetInterpolatedPointsIndices() [2/3]

virtual TIGL_EXPORT const boost::optional< CCPACSStringVector > & tigl::generated::CPACSApproximationSettings::GetInterpolatedPointsIndices ( ) const

virtual

GetInterpolatedPointsIndices() [3/3]

virtual TIGL_EXPORT CCPACSStringVector & tigl::generated::CPACSApproximationSettings::GetInterpolatedPointsIndices ( CreateIfNotExistsTag )

virtual

GetMaximumError_choice2()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSApproximationSettings::GetMaximumError_choice2 ( ) const

virtual

GetNextUIDParent() [1/2]

virtual TIGL_EXPORT CTiglUIDObject * tigl::generated::CPACSApproximationSettings::GetNextUIDParent ( )

virtual

GetNextUIDParent() [2/2]

virtual TIGL_EXPORT const CTiglUIDObject * tigl::generated::CPACSApproximationSettings::GetNextUIDParent ( ) const

virtual

GetParent() [1/2]

TIGL_EXPORT CCPACSCurvePointListXYZ * tigl::generated::CPACSApproximationSettings::GetParent

(

)

GetParent() [2/2]

TIGL_EXPORT const CCPACSCurvePointListXYZ * tigl::generated::CPACSApproximationSettings::GetParent

(

)

const

operator=() [1/2]

CPACSApproximationSettings & tigl::generated::CPACSApproximationSettings::operator= ( const CPACSApproximationSettings & )

privatedelete

operator=() [2/2]

CPACSApproximationSettings & tigl::generated::CPACSApproximationSettings::operator= ( CPACSApproximationSettings && )

privatedelete

ReadCPACS()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::ReadCPACS ( const TixiDocumentHandle & tixiHandle, const std::string & xpath )

virtual

RemoveInterpolatedPointsIndices()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::RemoveInterpolatedPointsIndices ( )

virtual

SetControlPointNumber_choice1()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::SetControlPointNumber_choice1 ( const boost::optional< int > & value )

virtual

SetErrorComputationMethod()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::SetErrorComputationMethod ( const boost::optional< std::string > & value )

virtual

SetMaximumError_choice2()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::SetMaximumError_choice2 ( const boost::optional< double > & value )

virtual

ValidateChoices()

TIGL_EXPORT bool tigl::generated::CPACSApproximationSettings::ValidateChoices

(

)

const

WriteCPACS()

virtual TIGL_EXPORT void tigl::generated::CPACSApproximationSettings::WriteCPACS ( const TixiDocumentHandle & tixiHandle, const std::string & xpath ) const

virtual

Field Documentation

m_controlPointNumber_choice1

boost::optional<int> tigl::generated::CPACSApproximationSettings::m_controlPointNumber_choice1

protected

Defines the number of control points that should be used for approximating the given points with a B-spline curve. The minimal value is 4.

m_errorComputationMethod

boost::optional<std::string> tigl::generated::CPACSApproximationSettings::m_errorComputationMethod

protected

Here, the approximation error's computation method can be chosen. The error is computed between the defined points (A) and their respective projections on the approximated curve (B). By default, this error is computed as the root mean square error of the distances between (A) and (B). In the following, the currently allowed entries are listed together with their meaning (-> respective computation method):

1. RMSE: Root Mean Square Error
2. MaxError: Maximum Error

m_interpolatedPointsIndices

boost::optional<CCPACSStringVector> tigl::generated::CPACSApproximationSettings::m_interpolatedPointsIndices

protected

Index list of points that should still be interpolated. Each index is in the range [1, npoints].

m_maximumError_choice2

boost::optional<double> tigl::generated::CPACSApproximationSettings::m_maximumError_choice2

protected

Instead of specifying the number of control points, the positive upper bound for the error of the approximation is provided. The number of control points is increased automatically until the approximation error lies below the given maximum approximation error.

m_parent

CCPACSCurvePointListXYZ* tigl::generated::CPACSApproximationSettings::m_parent

protected

---

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

• CPACSApproximationSettings.h