Guide Curve Type. More...

#include <CPACSGuideCurve.h>

Inheritance diagram for tigl::generated::CPACSGuideCurve:

Public Member Functions
TIGL_EXPORT	CPACSGuideCurve (CCPACSGuideCurves parent, CTiglUIDManager uidMgr)

virtual TIGL_EXPORT const boost::optional< CPACSGuideCurve_continuity > &	GetContinuity_choice1 () const

virtual TIGL_EXPORT const boost::optional< std::string > &	GetDescription () const

virtual TIGL_EXPORT const boost::optional< std::string > &	GetFromGuideCurveUID_choice1 () const

virtual TIGL_EXPORT const boost::optional< double > &	GetFromParameter_choice2_2 () const

virtual TIGL_EXPORT const boost::optional< double > &	GetFromRelativeCircumference_choice2_1 () const

virtual TIGL_EXPORT const std::string &	GetGuideCurveProfileUID () const

virtual TIGL_EXPORT const std::string &	GetName () const

virtual TIGL_EXPORT CTiglUIDObject *	GetNextUIDParent ()

virtual TIGL_EXPORT const CTiglUIDObject *	GetNextUIDParent () const

TIGL_EXPORT CCPACSGuideCurves *	GetParent ()

TIGL_EXPORT const CCPACSGuideCurves *	GetParent () const

virtual TIGL_EXPORT const boost::optional< CPACSPointXYZ > &	GetRXDirection () const

virtual TIGL_EXPORT boost::optional< CPACSPointXYZ > &	GetRXDirection ()

virtual TIGL_EXPORT CPACSPointXYZ &	GetRXDirection (CreateIfNotExistsTag)

virtual TIGL_EXPORT const boost::optional< CPACSPointXYZ > &	GetTangent () const

virtual TIGL_EXPORT boost::optional< CPACSPointXYZ > &	GetTangent ()

virtual TIGL_EXPORT CPACSPointXYZ &	GetTangent (CreateIfNotExistsTag)

virtual TIGL_EXPORT const boost::optional< CPACSPointXYZ > &	GetTangent_choice2 () const

virtual TIGL_EXPORT boost::optional< CPACSPointXYZ > &	GetTangent_choice2 ()

virtual TIGL_EXPORT CPACSPointXYZ &	GetTangent_choice2 (CreateIfNotExistsTag)

virtual TIGL_EXPORT const boost::optional< double > &	GetToParameter_choice2 () const

virtual TIGL_EXPORT const boost::optional< double > &	GetToRelativeCircumference_choice1 () const

virtual TIGL_EXPORT const std::string &	GetUID () const

TIGL_EXPORT CTiglUIDManager &	GetUIDManager ()

TIGL_EXPORT const CTiglUIDManager &	GetUIDManager () const

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

virtual TIGL_EXPORT void	RemoveRXDirection ()

virtual TIGL_EXPORT void	RemoveTangent ()

virtual TIGL_EXPORT void	RemoveTangent_choice2 ()

virtual TIGL_EXPORT void	SetContinuity_choice1 (const boost::optional< CPACSGuideCurve_continuity > &value)

virtual TIGL_EXPORT void	SetDescription (const boost::optional< std::string > &value)

virtual TIGL_EXPORT void	SetFromGuideCurveUID_choice1 (const boost::optional< std::string > &value)

virtual TIGL_EXPORT void	SetFromParameter_choice2_2 (const boost::optional< double > &value)

virtual TIGL_EXPORT void	SetFromRelativeCircumference_choice2_1 (const boost::optional< double > &value)

virtual TIGL_EXPORT void	SetGuideCurveProfileUID (const std::string &value)

virtual TIGL_EXPORT void	SetName (const std::string &value)

virtual TIGL_EXPORT void	SetToParameter_choice2 (const boost::optional< double > &value)

virtual TIGL_EXPORT void	SetToRelativeCircumference_choice1 (const boost::optional< double > &value)

virtual TIGL_EXPORT void	SetUID (const std::string &value)

TIGL_EXPORT bool	ValidateChoices () const

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

virtual TIGL_EXPORT	~CPACSGuideCurve ()

Public Member Functions inherited from tigl::CTiglReqUIDObject
boost::optional< std::string >	GetObjectUID () const

virtual	~CTiglReqUIDObject ()=default

Public Member Functions inherited from tigl::CTiglUIDObject
TIGL_EXPORT void	Invalidate (const boost::optional< std::string > &source=boost::none) const

Public Member Functions inherited from tigl::ITiglUIDRefObject
virtual	~ITiglUIDRefObject ()=default

Protected Attributes
boost::optional< CPACSGuideCurve_continuity >	m_continuity_choice1
	Continuity definition for geometry generation. Possible options: C0, C1 from previous, C2 from previous, C1 to previous, C2 to previous. More...

boost::optional< std::string >	m_description
	Description of guide curve. More...

boost::optional< std::string >	m_fromGuideCurveUID_choice1
	Reference to the previous guide curve from which this guide curve shall start. More...

boost::optional< double >	m_fromParameter_choice2_2
	Reference to the parameter position from which the guide curve shall start. Valid values are in the interval -1.0...1.0. More...

boost::optional< double >	m_fromRelativeCircumference_choice2_1
	Reference to the relative circumference position from which the guide curve shall start. Valid values are in the interval -1.0...1.0. More...

std::string	m_guideCurveProfileUID
	Reference to a guide curve profile. More...

std::string	m_name
	Name of guide curve. More...

CCPACSGuideCurves *	m_parent

boost::optional< CPACSPointXYZ >	m_rXDirection
	Local direction along which the relative x-coordinates of the guide curve points are defined. For the wing the default is the wing's local x-axis, for the fuselage its the fuselage's local z-axis. More...

boost::optional< CPACSPointXYZ >	m_tangent
	Tangent at last point. More...

boost::optional< CPACSPointXYZ >	m_tangent_choice2
	Tangent at first point. More...

boost::optional< double >	m_toParameter_choice2
	The parameter position at which the guide curve shall end. Valid values are in the interval -1.0...1.0. More...

boost::optional< double >	m_toRelativeCircumference_choice1
	The relative circumference position at which the guide curve shall end. Valid values are in the interval -1,...,1. More...

std::string	m_uID

CTiglUIDManager *	m_uidMgr

Private Member Functions
	CPACSGuideCurve (const CPACSGuideCurve &)=delete

	CPACSGuideCurve (CPACSGuideCurve &&)=delete

TIGL_EXPORT const CTiglUIDObject *	GetNextUIDObject () const final

TIGL_EXPORT void	NotifyUIDChange (const std::string &oldUid, const std::string &newUid) final

CPACSGuideCurve &	operator= (const CPACSGuideCurve &)=delete

CPACSGuideCurve &	operator= (CPACSGuideCurve &&)=delete

Additional Inherited Members
Protected Member Functions inherited from tigl::CTiglUIDObject
	~CTiglUIDObject ()=default

Detailed Description

Guide Curve Type.

A guide curve may be used to alter the shape of the outer geometry and "guide" the loft. The guide curve profiles are defined in the guideCurveProfileGeometryType. Their use on wing and fuselage components is illustrated in the image below.

See also: guideCurveIllustration

Constructor & Destructor Documentation

◆ CPACSGuideCurve() [1/3]

TIGL_EXPORT tigl::generated::CPACSGuideCurve::CPACSGuideCurve	(	CCPACSGuideCurves *	parent,
		CTiglUIDManager *	uidMgr
	)

◆ ~CPACSGuideCurve()

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

virtual

◆ CPACSGuideCurve() [2/3]

tigl::generated::CPACSGuideCurve::CPACSGuideCurve ( const CPACSGuideCurve & )

privatedelete

◆ CPACSGuideCurve() [3/3]

tigl::generated::CPACSGuideCurve::CPACSGuideCurve ( CPACSGuideCurve && )

privatedelete

Member Function Documentation

◆ GetContinuity_choice1()

virtual TIGL_EXPORT const boost::optional<CPACSGuideCurve_continuity>& tigl::generated::CPACSGuideCurve::GetContinuity_choice1 ( ) const

virtual

◆ GetDescription()

virtual TIGL_EXPORT const boost::optional<std::string>& tigl::generated::CPACSGuideCurve::GetDescription ( ) const

virtual

◆ GetFromGuideCurveUID_choice1()

virtual TIGL_EXPORT const boost::optional<std::string>& tigl::generated::CPACSGuideCurve::GetFromGuideCurveUID_choice1 ( ) const

virtual

◆ GetFromParameter_choice2_2()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSGuideCurve::GetFromParameter_choice2_2 ( ) const

virtual

◆ GetFromRelativeCircumference_choice2_1()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSGuideCurve::GetFromRelativeCircumference_choice2_1 ( ) const

virtual

◆ GetGuideCurveProfileUID()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSGuideCurve::GetGuideCurveProfileUID ( ) const

virtual

◆ GetName()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSGuideCurve::GetName ( ) const

virtual

◆ GetNextUIDObject()

TIGL_EXPORT const CTiglUIDObject* tigl::generated::CPACSGuideCurve::GetNextUIDObject ( ) const

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ GetNextUIDParent() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetNextUIDParent() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetParent() [1/2]

TIGL_EXPORT CCPACSGuideCurves* tigl::generated::CPACSGuideCurve::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CCPACSGuideCurves* tigl::generated::CPACSGuideCurve::GetParent ( ) const

◆ GetRXDirection() [1/3]

virtual TIGL_EXPORT const boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetRXDirection ( ) const

virtual

◆ GetRXDirection() [2/3]

virtual TIGL_EXPORT boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetRXDirection ( )

virtual

◆ GetRXDirection() [3/3]

virtual TIGL_EXPORT CPACSPointXYZ& tigl::generated::CPACSGuideCurve::GetRXDirection ( CreateIfNotExistsTag )

virtual

◆ GetTangent() [1/3]

virtual TIGL_EXPORT const boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetTangent ( ) const

virtual

◆ GetTangent() [2/3]

virtual TIGL_EXPORT boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetTangent ( )

virtual

◆ GetTangent() [3/3]

virtual TIGL_EXPORT CPACSPointXYZ& tigl::generated::CPACSGuideCurve::GetTangent ( CreateIfNotExistsTag )

virtual

◆ GetTangent_choice2() [1/3]

virtual TIGL_EXPORT const boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetTangent_choice2 ( ) const

virtual

◆ GetTangent_choice2() [2/3]

virtual TIGL_EXPORT boost::optional<CPACSPointXYZ>& tigl::generated::CPACSGuideCurve::GetTangent_choice2 ( )

virtual

◆ GetTangent_choice2() [3/3]

virtual TIGL_EXPORT CPACSPointXYZ& tigl::generated::CPACSGuideCurve::GetTangent_choice2 ( CreateIfNotExistsTag )

virtual

◆ GetToParameter_choice2()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSGuideCurve::GetToParameter_choice2 ( ) const

virtual

◆ GetToRelativeCircumference_choice1()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSGuideCurve::GetToRelativeCircumference_choice1 ( ) const

virtual

◆ GetUID()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSGuideCurve::GetUID ( ) const

virtual

Implements tigl::CTiglReqUIDObject.

◆ GetUIDManager() [1/2]

TIGL_EXPORT CTiglUIDManager& tigl::generated::CPACSGuideCurve::GetUIDManager ( )

virtual

Implements tigl::CTiglUIDObject.

◆ GetUIDManager() [2/2]

TIGL_EXPORT const CTiglUIDManager& tigl::generated::CPACSGuideCurve::GetUIDManager ( ) const

virtual

Implements tigl::CTiglUIDObject.

◆ NotifyUIDChange()

TIGL_EXPORT void tigl::generated::CPACSGuideCurve::NotifyUIDChange	(	const std::string &	oldUid,
		const std::string &	newUid
	)

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ operator=() [1/2]

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

privatedelete

◆ operator=() [2/2]

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

privatedelete

◆ ReadCPACS()

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

virtual

◆ RemoveRXDirection()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::RemoveRXDirection ( )

virtual

◆ RemoveTangent()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::RemoveTangent ( )

virtual

◆ RemoveTangent_choice2()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::RemoveTangent_choice2 ( )

virtual

◆ SetContinuity_choice1()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::SetContinuity_choice1 ( const boost::optional< CPACSGuideCurve_continuity > & value )

virtual

◆ SetDescription()

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

virtual

◆ SetFromGuideCurveUID_choice1()

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

virtual

◆ SetFromParameter_choice2_2()

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

virtual

◆ SetFromRelativeCircumference_choice2_1()

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

virtual

◆ SetGuideCurveProfileUID()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::SetGuideCurveProfileUID ( const std::string & value )

virtual

◆ SetName()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::SetName ( const std::string & value )

virtual

◆ SetToParameter_choice2()

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

virtual

◆ SetToRelativeCircumference_choice1()

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

virtual

◆ SetUID()

virtual TIGL_EXPORT void tigl::generated::CPACSGuideCurve::SetUID ( const std::string & value )

virtual

◆ ValidateChoices()

TIGL_EXPORT bool tigl::generated::CPACSGuideCurve::ValidateChoices ( ) const

◆ WriteCPACS()

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

virtual

Field Documentation

◆ m_continuity_choice1

boost::optional<CPACSGuideCurve_continuity> tigl::generated::CPACSGuideCurve::m_continuity_choice1

protected

Continuity definition for geometry generation. Possible options: C0, C1 from previous, C2 from previous, C1 to previous, C2 to previous.

◆ m_description

boost::optional<std::string> tigl::generated::CPACSGuideCurve::m_description

protected

Description of guide curve.

◆ m_fromGuideCurveUID_choice1

boost::optional<std::string> tigl::generated::CPACSGuideCurve::m_fromGuideCurveUID_choice1

protected

Reference to the previous guide curve from which this guide curve shall start.

◆ m_fromParameter_choice2_2

boost::optional<double> tigl::generated::CPACSGuideCurve::m_fromParameter_choice2_2

protected

Reference to the parameter position from which the guide curve shall start. Valid values are in the interval -1.0...1.0.

◆ m_fromRelativeCircumference_choice2_1

boost::optional<double> tigl::generated::CPACSGuideCurve::m_fromRelativeCircumference_choice2_1

protected

Reference to the relative circumference position from which the guide curve shall start. Valid values are in the interval -1.0...1.0.

◆ m_guideCurveProfileUID

std::string tigl::generated::CPACSGuideCurve::m_guideCurveProfileUID

protected

Reference to a guide curve profile.

◆ m_name

std::string tigl::generated::CPACSGuideCurve::m_name

protected

Name of guide curve.

◆ m_parent

CCPACSGuideCurves* tigl::generated::CPACSGuideCurve::m_parent

protected

◆ m_rXDirection

boost::optional<CPACSPointXYZ> tigl::generated::CPACSGuideCurve::m_rXDirection

protected

Local direction along which the relative x-coordinates of the guide curve points are defined. For the wing the default is the wing's local x-axis, for the fuselage its the fuselage's local z-axis.

◆ m_tangent

boost::optional<CPACSPointXYZ> tigl::generated::CPACSGuideCurve::m_tangent

protected

Tangent at last point.

◆ m_tangent_choice2

boost::optional<CPACSPointXYZ> tigl::generated::CPACSGuideCurve::m_tangent_choice2

protected

Tangent at first point.

◆ m_toParameter_choice2

boost::optional<double> tigl::generated::CPACSGuideCurve::m_toParameter_choice2

protected

The parameter position at which the guide curve shall end. Valid values are in the interval -1.0...1.0.

◆ m_toRelativeCircumference_choice1

boost::optional<double> tigl::generated::CPACSGuideCurve::m_toRelativeCircumference_choice1

protected

The relative circumference position at which the guide curve shall end. Valid values are in the interval -1,...,1.

◆ m_uID

std::string tigl::generated::CPACSGuideCurve::m_uID

protected

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSGuideCurve::m_uidMgr

protected

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

CPACSGuideCurve.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CPACSGuideCurve() [1/3]

◆ ~CPACSGuideCurve()

◆ CPACSGuideCurve() [2/3]

◆ CPACSGuideCurve() [3/3]

Member Function Documentation

◆ GetContinuity_choice1()

◆ GetDescription()

◆ GetFromGuideCurveUID_choice1()

◆ GetFromParameter_choice2_2()

◆ GetFromRelativeCircumference_choice2_1()

◆ GetGuideCurveProfileUID()

◆ GetName()

◆ GetNextUIDObject()

◆ GetNextUIDParent() [1/2]

◆ GetNextUIDParent() [2/2]

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetRXDirection() [1/3]

◆ GetRXDirection() [2/3]

◆ GetRXDirection() [3/3]

◆ GetTangent() [1/3]

◆ GetTangent() [2/3]

◆ GetTangent() [3/3]

◆ GetTangent_choice2() [1/3]

◆ GetTangent_choice2() [2/3]

◆ GetTangent_choice2() [3/3]

◆ GetToParameter_choice2()

◆ GetToRelativeCircumference_choice1()

◆ GetUID()

◆ GetUIDManager() [1/2]

◆ GetUIDManager() [2/2]

◆ NotifyUIDChange()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadCPACS()

◆ RemoveRXDirection()

◆ RemoveTangent()

◆ RemoveTangent_choice2()

◆ SetContinuity_choice1()

◆ SetDescription()

◆ SetFromGuideCurveUID_choice1()

◆ SetFromParameter_choice2_2()

◆ SetFromRelativeCircumference_choice2_1()

◆ SetGuideCurveProfileUID()

◆ SetName()

◆ SetToParameter_choice2()

◆ SetToRelativeCircumference_choice1()

◆ SetUID()

◆ ValidateChoices()

◆ WriteCPACS()

Field Documentation

◆ m_continuity_choice1

◆ m_description

◆ m_fromGuideCurveUID_choice1

◆ m_fromParameter_choice2_2

◆ m_fromRelativeCircumference_choice2_1

◆ m_guideCurveProfileUID

◆ m_name

◆ m_parent

◆ m_rXDirection

◆ m_tangent

◆ m_tangent_choice2

◆ m_toParameter_choice2

◆ m_toRelativeCircumference_choice1

◆ m_uID

◆ m_uidMgr