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

ComponentSegment of the wing. More...

#include <CPACSComponentSegment.h>

+ Inheritance diagram for tigl::generated::CPACSComponentSegment:

Public Member Functions

TIGL_EXPORT CPACSComponentSegment (CCPACSWingComponentSegments *parent, CTiglUIDManager *uidMgr)
 
virtual TIGL_EXPORT const boost::optional< CCPACSControlSurfaces > & GetControlSurfaces () const
 
virtual TIGL_EXPORT boost::optional< CCPACSControlSurfaces > & GetControlSurfaces ()
 
virtual TIGL_EXPORT CCPACSControlSurfaces & GetControlSurfaces (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetDescription () const
 
virtual TIGL_EXPORT const std::string & GetFromElementUID () const
 
virtual TIGL_EXPORT const std::string & GetName () const
 
virtual TIGL_EXPORT CTiglUIDObject * GetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObject * GetNextUIDParent () const
 
TIGL_EXPORT CCPACSWingComponentSegments * GetParent ()
 
TIGL_EXPORT const CCPACSWingComponentSegments * GetParent () const
 
virtual TIGL_EXPORT const boost::optional< CCPACSWingCSStructure > & GetStructure () const
 
virtual TIGL_EXPORT boost::optional< CCPACSWingCSStructure > & GetStructure ()
 
virtual TIGL_EXPORT CCPACSWingCSStructure & GetStructure (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT const std::string & GetToElementUID () 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 RemoveControlSurfaces ()
 
virtual TIGL_EXPORT void RemoveStructure ()
 
virtual TIGL_EXPORT void SetDescription (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetFromElementUID (const std::string &value)
 
virtual TIGL_EXPORT void SetName (const std::string &value)
 
virtual TIGL_EXPORT void SetToElementUID (const std::string &value)
 
virtual TIGL_EXPORT void SetUID (const std::string &value)
 
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
 
virtual TIGL_EXPORT ~CPACSComponentSegment ()
 
- 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< CCPACSControlSurfaces > m_controlSurfaces
 
boost::optional< std::string > m_description
 Description of the componentSegment. More...
 
std::string m_fromElementUID
 Reference to the element from which the componentSegment shall start. More...
 
std::string m_name
 Name of the wing componentSegment. More...
 
CCPACSWingComponentSegments * m_parent
 
boost::optional< CCPACSWingCSStructure > m_structure
 
std::string m_toElementUID
 Reference to the element from which the componentSegment shall end. More...
 
std::string m_uID
 
CTiglUIDManager * m_uidMgr
 

Private Member Functions

 CPACSComponentSegment (const CPACSComponentSegment &)=delete
 
 CPACSComponentSegment (CPACSComponentSegment &&)=delete
 
TIGL_EXPORT const CTiglUIDObject * GetNextUIDObject () const final
 
TIGL_EXPORT void NotifyUIDChange (const std::string &oldUid, const std::string &newUid) final
 
CPACSComponentSegment & operator= (const CPACSComponentSegment &)=delete
 
CPACSComponentSegment & operator= (CPACSComponentSegment &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from tigl::CTiglUIDObject
 ~CTiglUIDObject ()=default
 

Detailed Description

ComponentSegment of the wing.

Within componentSegments the wing structure, the control surfaces, the wing fuel tanks and the wingFuselageAttachment is defined by using relative coordinates. A componentSegment is defined in the same way as segments: from one cross section (sections->elements) to another. Compared to segments one componentSegment can can start and end at elements that are not consecutive. Therefore that one componentSegment can be the combination of several segments. Each wing has at least one componentSegment (from root to tip). The maximal number of componentSegments equals the number of segments (each segment is defined as one componentSegment). This also implies that each segment can only be part of one componentSegment. In principal a componentSegment can combine any number of segments. But if in one section two elements are defined, the componentSegment has to start/end there as no well-defined relative coordinats can be defined if steps in the wing occure. An example for wing componentSegments can be found in the picture below:

See also
wingcomponentsegments Within componentSegments a relative spanwise coordinate (eta) and a relative chordwise coordinate (xsi) is defined. Those coordinates are used for the definition of e.g. wing structures and control surfaces. there are two types of eta xsi coordinates. Segment (eta, xsi) coordinates define the relative local coordinate system for a segment ranging from (0,0) to (1,1).
componentsegments_1 The eta xsi coordinates for a component segment are based on the segment eta xsi planes. As a reference length for the component segment eta coordinate the mid chord lines of all the segments are used. The beginning of this line at from-element equals eta = 0, while the end of this line at the to-element equals eta = 1. All wing positions that lie on the same element (segment border) have the same eta coordinate. The points inbetween two elements are defined by the iso xsi lines of the segment eta xsi space. An example for the definition of the relative axes can be found in the picture below:
componentsegments_2 In order to calculate the global coordinates of a component segment eta xsi point one first has to calculate the eta point on the xsi iso line of (xsi=0.5), and then walk along the iso eta lineof the segment. An example for determining the a component eta xsi point can be found in the picture below:
componentsegments_3

Constructor & Destructor Documentation

◆ CPACSComponentSegment() [1/3]

TIGL_EXPORT tigl::generated::CPACSComponentSegment::CPACSComponentSegment ( CCPACSWingComponentSegments *  parent,
CTiglUIDManager *  uidMgr 
)

◆ ~CPACSComponentSegment()

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

◆ CPACSComponentSegment() [2/3]

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

◆ CPACSComponentSegment() [3/3]

tigl::generated::CPACSComponentSegment::CPACSComponentSegment ( CPACSComponentSegment &&  )
privatedelete

Member Function Documentation

◆ GetControlSurfaces() [1/3]

virtual TIGL_EXPORT const boost::optional<CCPACSControlSurfaces>& tigl::generated::CPACSComponentSegment::GetControlSurfaces ( ) const
virtual

◆ GetControlSurfaces() [2/3]

virtual TIGL_EXPORT boost::optional<CCPACSControlSurfaces>& tigl::generated::CPACSComponentSegment::GetControlSurfaces ( )
virtual

◆ GetControlSurfaces() [3/3]

virtual TIGL_EXPORT CCPACSControlSurfaces& tigl::generated::CPACSComponentSegment::GetControlSurfaces ( CreateIfNotExistsTag  )
virtual

◆ GetDescription()

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

◆ GetFromElementUID()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSComponentSegment::GetFromElementUID ( ) const
virtual

◆ GetName()

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

◆ GetNextUIDObject()

TIGL_EXPORT const CTiglUIDObject* tigl::generated::CPACSComponentSegment::GetNextUIDObject ( ) const
finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ GetNextUIDParent() [1/2]

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

Implements tigl::CTiglUIDObject.

◆ GetNextUIDParent() [2/2]

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

Implements tigl::CTiglUIDObject.

◆ GetParent() [1/2]

TIGL_EXPORT CCPACSWingComponentSegments* tigl::generated::CPACSComponentSegment::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CCPACSWingComponentSegments* tigl::generated::CPACSComponentSegment::GetParent ( ) const

◆ GetStructure() [1/3]

virtual TIGL_EXPORT const boost::optional<CCPACSWingCSStructure>& tigl::generated::CPACSComponentSegment::GetStructure ( ) const
virtual

◆ GetStructure() [2/3]

virtual TIGL_EXPORT boost::optional<CCPACSWingCSStructure>& tigl::generated::CPACSComponentSegment::GetStructure ( )
virtual

◆ GetStructure() [3/3]

virtual TIGL_EXPORT CCPACSWingCSStructure& tigl::generated::CPACSComponentSegment::GetStructure ( CreateIfNotExistsTag  )
virtual

◆ GetToElementUID()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSComponentSegment::GetToElementUID ( ) const
virtual

◆ GetUID()

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

Implements tigl::CTiglReqUIDObject.

◆ GetUIDManager() [1/2]

TIGL_EXPORT CTiglUIDManager& tigl::generated::CPACSComponentSegment::GetUIDManager ( )
virtual

Implements tigl::CTiglUIDObject.

◆ GetUIDManager() [2/2]

TIGL_EXPORT const CTiglUIDManager& tigl::generated::CPACSComponentSegment::GetUIDManager ( ) const
virtual

Implements tigl::CTiglUIDObject.

◆ NotifyUIDChange()

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

Implements tigl::ITiglUIDRefObject.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

Reimplemented in tigl::CCPACSWingComponentSegment.

◆ RemoveControlSurfaces()

virtual TIGL_EXPORT void tigl::generated::CPACSComponentSegment::RemoveControlSurfaces ( )
virtual

◆ RemoveStructure()

virtual TIGL_EXPORT void tigl::generated::CPACSComponentSegment::RemoveStructure ( )
virtual

◆ SetDescription()

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

◆ SetFromElementUID()

virtual TIGL_EXPORT void tigl::generated::CPACSComponentSegment::SetFromElementUID ( const std::string &  value)
virtual

◆ SetName()

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

◆ SetToElementUID()

virtual TIGL_EXPORT void tigl::generated::CPACSComponentSegment::SetToElementUID ( const std::string &  value)
virtual

◆ SetUID()

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

◆ WriteCPACS()

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

Field Documentation

◆ m_controlSurfaces

boost::optional<CCPACSControlSurfaces> tigl::generated::CPACSComponentSegment::m_controlSurfaces
protected

◆ m_description

boost::optional<std::string> tigl::generated::CPACSComponentSegment::m_description
protected

Description of the componentSegment.

◆ m_fromElementUID

std::string tigl::generated::CPACSComponentSegment::m_fromElementUID
protected

Reference to the element from which the componentSegment shall start.

◆ m_name

std::string tigl::generated::CPACSComponentSegment::m_name
protected

Name of the wing componentSegment.

◆ m_parent

CCPACSWingComponentSegments* tigl::generated::CPACSComponentSegment::m_parent
protected

◆ m_structure

boost::optional<CCPACSWingCSStructure> tigl::generated::CPACSComponentSegment::m_structure
protected

◆ m_toElementUID

std::string tigl::generated::CPACSComponentSegment::m_toElementUID
protected

Reference to the element from which the componentSegment shall end.

◆ m_uID

std::string tigl::generated::CPACSComponentSegment::m_uID
protected

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSComponentSegment::m_uidMgr
protected
The documentation for this class was generated from the following file: