3.4.0
Public Member Functions | Protected Attributes | Private Member Functions
tigl::generated::CPACSCurvePointListXYZ Class Reference

A curve that interpolates a list of points. More...

#include <CPACSCurvePointListXYZ.h>

+ Inheritance diagram for tigl::generated::CPACSCurvePointListXYZ:

Public Member Functions

TIGL_EXPORT CPACSCurvePointListXYZ (CPACSProfileGeometry *parent)
 
virtual TIGL_EXPORT const boost::optional< CCPACSStringVector > & GetKinkIndices () const
 
virtual TIGL_EXPORT boost::optional< CCPACSStringVector > & GetKinkIndices ()
 
virtual TIGL_EXPORT CCPACSStringVector & GetKinkIndices (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT CTiglUIDObject * GetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObject * GetNextUIDParent () const
 
virtual TIGL_EXPORT const boost::optional< CCPACSCurveParamPointMap > & GetParameterMap () const
 
virtual TIGL_EXPORT boost::optional< CCPACSCurveParamPointMap > & GetParameterMap ()
 
virtual TIGL_EXPORT CCPACSCurveParamPointMap & GetParameterMap (CreateIfNotExistsTag)
 
TIGL_EXPORT CPACSProfileGeometry * GetParent ()
 
TIGL_EXPORT const CPACSProfileGeometry * GetParent () const
 
virtual TIGL_EXPORT const CCPACSStringVector & GetX () const
 
virtual TIGL_EXPORT CCPACSStringVector & GetX ()
 
virtual TIGL_EXPORT const CCPACSStringVector & GetY () const
 
virtual TIGL_EXPORT CCPACSStringVector & GetY ()
 
virtual TIGL_EXPORT const CCPACSStringVector & GetZ () const
 
virtual TIGL_EXPORT CCPACSStringVector & GetZ ()
 
virtual TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
 
virtual TIGL_EXPORT void RemoveKinkIndices ()
 
virtual TIGL_EXPORT void RemoveParameterMap ()
 
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
 
virtual TIGL_EXPORT ~CPACSCurvePointListXYZ ()
 

Protected Attributes

boost::optional< CCPACSStringVector > m_kinkIndices
 Indices of points at which the curve has a kink. Each index is in the range [1, npoints]. More...
 
boost::optional< CCPACSCurveParamPointMap > m_parameterMap
 Map between point index and curve parameter. More...
 
CPACSProfileGeometry * m_parent
 
CCPACSStringVector m_x
 Vector of x coordinates. More...
 
CCPACSStringVector m_y
 Vector of y coordinates. More...
 
CCPACSStringVector m_z
 Vector of z coordinates. More...
 

Private Member Functions

 CPACSCurvePointListXYZ (const CPACSCurvePointListXYZ &)=delete
 
 CPACSCurvePointListXYZ (CPACSCurvePointListXYZ &&)=delete
 
CPACSCurvePointListXYZ & operator= (const CPACSCurvePointListXYZ &)=delete
 
CPACSCurvePointListXYZ & operator= (CPACSCurvePointListXYZ &&)=delete
 

Detailed Description

A curve that interpolates a list of points.

The curve interpolates the list of points, typically with a b-spline. In theory, the interpolation is somewhat ambiguous as it is not defined at which curve parameter a point will be interpolated. To solve is ambiguity, an optional parameter map can be defined that maps point indices with curve parameters. Kinks can also be modeled by populating the "kinks" array with the indices of points that should be on a kink. As an example, look at the following image:

See also
curve_point_list_xyz In this example, the kinks array will be "3;7". Optionally, the parameters of the kinks can be set in the parameter map. The whole profile looks as follows:

<pointList> <x>...</x> <y>...</y> <z>...</z> <kinks>3;7</kinks> <parameterMap> <pointIndex>3;5;7</pointIndex> <paramOnCurve>0.2;0.5;0.8</paramOnCurve> </parameterMap> </pointList>

Constructor & Destructor Documentation

◆ CPACSCurvePointListXYZ() [1/3]

TIGL_EXPORT tigl::generated::CPACSCurvePointListXYZ::CPACSCurvePointListXYZ ( CPACSProfileGeometry *  parent)

◆ ~CPACSCurvePointListXYZ()

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

◆ CPACSCurvePointListXYZ() [2/3]

tigl::generated::CPACSCurvePointListXYZ::CPACSCurvePointListXYZ ( const CPACSCurvePointListXYZ &  )
privatedelete

◆ CPACSCurvePointListXYZ() [3/3]

tigl::generated::CPACSCurvePointListXYZ::CPACSCurvePointListXYZ ( CPACSCurvePointListXYZ &&  )
privatedelete

Member Function Documentation

◆ GetKinkIndices() [1/3]

virtual TIGL_EXPORT const boost::optional<CCPACSStringVector>& tigl::generated::CPACSCurvePointListXYZ::GetKinkIndices ( ) const
virtual

◆ GetKinkIndices() [2/3]

virtual TIGL_EXPORT boost::optional<CCPACSStringVector>& tigl::generated::CPACSCurvePointListXYZ::GetKinkIndices ( )
virtual

◆ GetKinkIndices() [3/3]

virtual TIGL_EXPORT CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetKinkIndices ( CreateIfNotExistsTag  )
virtual

◆ GetNextUIDParent() [1/2]

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

◆ GetNextUIDParent() [2/2]

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

◆ GetParameterMap() [1/3]

virtual TIGL_EXPORT const boost::optional<CCPACSCurveParamPointMap>& tigl::generated::CPACSCurvePointListXYZ::GetParameterMap ( ) const
virtual

◆ GetParameterMap() [2/3]

virtual TIGL_EXPORT boost::optional<CCPACSCurveParamPointMap>& tigl::generated::CPACSCurvePointListXYZ::GetParameterMap ( )
virtual

◆ GetParameterMap() [3/3]

virtual TIGL_EXPORT CCPACSCurveParamPointMap& tigl::generated::CPACSCurvePointListXYZ::GetParameterMap ( CreateIfNotExistsTag  )
virtual

◆ GetParent() [1/2]

TIGL_EXPORT CPACSProfileGeometry* tigl::generated::CPACSCurvePointListXYZ::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSProfileGeometry* tigl::generated::CPACSCurvePointListXYZ::GetParent ( ) const

◆ GetX() [1/2]

virtual TIGL_EXPORT const CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetX ( ) const
virtual

◆ GetX() [2/2]

virtual TIGL_EXPORT CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetX ( )
virtual

◆ GetY() [1/2]

virtual TIGL_EXPORT const CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetY ( ) const
virtual

◆ GetY() [2/2]

virtual TIGL_EXPORT CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetY ( )
virtual

◆ GetZ() [1/2]

virtual TIGL_EXPORT const CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetZ ( ) const
virtual

◆ GetZ() [2/2]

virtual TIGL_EXPORT CCPACSStringVector& tigl::generated::CPACSCurvePointListXYZ::GetZ ( )
virtual

◆ operator=() [1/2]

CPACSCurvePointListXYZ& tigl::generated::CPACSCurvePointListXYZ::operator= ( const CPACSCurvePointListXYZ &  )
privatedelete

◆ operator=() [2/2]

CPACSCurvePointListXYZ& tigl::generated::CPACSCurvePointListXYZ::operator= ( CPACSCurvePointListXYZ &&  )
privatedelete

◆ ReadCPACS()

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

Reimplemented in tigl::CCPACSCurvePointListXYZ.

◆ RemoveKinkIndices()

virtual TIGL_EXPORT void tigl::generated::CPACSCurvePointListXYZ::RemoveKinkIndices ( )
virtual

◆ RemoveParameterMap()

virtual TIGL_EXPORT void tigl::generated::CPACSCurvePointListXYZ::RemoveParameterMap ( )
virtual

◆ WriteCPACS()

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

Field Documentation

◆ m_kinkIndices

boost::optional<CCPACSStringVector> tigl::generated::CPACSCurvePointListXYZ::m_kinkIndices
protected

Indices of points at which the curve has a kink. Each index is in the range [1, npoints].

◆ m_parameterMap

boost::optional<CCPACSCurveParamPointMap> tigl::generated::CPACSCurvePointListXYZ::m_parameterMap
protected

Map between point index and curve parameter.

◆ m_parent

CPACSProfileGeometry* tigl::generated::CPACSCurvePointListXYZ::m_parent
protected

◆ m_x

CCPACSStringVector tigl::generated::CPACSCurvePointListXYZ::m_x
protected

Vector of x coordinates.

◆ m_y

CCPACSStringVector tigl::generated::CPACSCurvePointListXYZ::m_y
protected

Vector of y coordinates.

◆ m_z

CCPACSStringVector tigl::generated::CPACSCurvePointListXYZ::m_z
protected

Vector of z coordinates.

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