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

controlSurfaceStepType More...

#include <CPACSControlSurfaceStep.h>

Public Member Functions

TIGL_EXPORT CPACSControlSurfaceStep (CPACSControlSurfaceSteps *parent, CTiglUIDManager *uidMgr)
 
virtual TIGL_EXPORT const double & GetControlParameter () const
 
virtual TIGL_EXPORT const boost::optional< double > & GetHingeLineRotation () const
 
virtual TIGL_EXPORT const boost::optional< CCPACSPoint > & GetInnerHingeTranslation () const
 
virtual TIGL_EXPORT boost::optional< CCPACSPoint > & GetInnerHingeTranslation ()
 
virtual TIGL_EXPORT CCPACSPoint & GetInnerHingeTranslation (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT CTiglUIDObject * GetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObject * GetNextUIDParent () const
 
virtual TIGL_EXPORT const boost::optional< CPACSPointXZ > & GetOuterHingeTranslation () const
 
virtual TIGL_EXPORT boost::optional< CPACSPointXZ > & GetOuterHingeTranslation ()
 
virtual TIGL_EXPORT CPACSPointXZ & GetOuterHingeTranslation (CreateIfNotExistsTag)
 
TIGL_EXPORT CPACSControlSurfaceSteps * GetParent ()
 
TIGL_EXPORT const CPACSControlSurfaceSteps * GetParent () 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 RemoveInnerHingeTranslation ()
 
virtual TIGL_EXPORT void RemoveOuterHingeTranslation ()
 
virtual TIGL_EXPORT void SetControlParameter (const double &value)
 
virtual TIGL_EXPORT void SetHingeLineRotation (const boost::optional< double > &value)
 
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
 
virtual TIGL_EXPORT ~CPACSControlSurfaceStep ()
 

Protected Attributes

double m_controlParameter
 The control parameter links a generic floating point value to a certain status of a control device (e.g. control surface, landing gear, suction system, brake parachute, ...). See the documentation of the global CPACS-Element for further information. More...
 
boost::optional< double > m_hingeLineRotation
 Positve rotation around the hinge line, heading from the inner to the outer border. Defaults to zero. More...
 
boost::optional< CCPACSPoint > m_innerHingeTranslation
 Translation of the inner hinge line point within the hinge line coordinate system. Defaults to zero. Not allowed for spoilers! More...
 
boost::optional< CPACSPointXZ > m_outerHingeTranslation
 Translation of the outer hinge line point within the hinge line coordinate system. Defaults to the values of the inner hinge line point. Not allowed for spoilers! More...
 
CPACSControlSurfaceSteps * m_parent
 
CTiglUIDManager * m_uidMgr
 

Private Member Functions

 CPACSControlSurfaceStep (const CPACSControlSurfaceStep &)=delete
 
 CPACSControlSurfaceStep (CPACSControlSurfaceStep &&)=delete
 
CPACSControlSurfaceStep & operator= (const CPACSControlSurfaceStep &)=delete
 
CPACSControlSurfaceStep & operator= (CPACSControlSurfaceStep &&)=delete
 

Detailed Description

controlSurfaceStepType

The deflection path of the control surface is defined within the hinge line coordinat system. This is defined as follows: The x-hinge coordinate equals the wing x-axis. The y-hinge coordinate equals the hinge line axis (see above; positive from inner to outer hinge point). The z-hinge line is perpendicular on the x-hinge and y-hinge coordinate according to the right hand rule. The rotation of the control surface is defined as rotation around the positive y-hinge line. The deflection of the is defined in any number of steps. The deflection of the control surface is done as follows: First the x-deflection at the inner and outer border; afterwards the z-deflection of the inner and outer border; last the y-deflection of the inner border. The y-deflection is only defined at the inner border, as it is identical to the outer border. If no values for the outer border deflection are given, they default to the values of the inner border. An example can be found below:

See also
path

Constructor & Destructor Documentation

◆ CPACSControlSurfaceStep() [1/3]

TIGL_EXPORT tigl::generated::CPACSControlSurfaceStep::CPACSControlSurfaceStep ( CPACSControlSurfaceSteps *  parent,
CTiglUIDManager *  uidMgr 
)

◆ ~CPACSControlSurfaceStep()

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

◆ CPACSControlSurfaceStep() [2/3]

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

◆ CPACSControlSurfaceStep() [3/3]

tigl::generated::CPACSControlSurfaceStep::CPACSControlSurfaceStep ( CPACSControlSurfaceStep &&  )
privatedelete

Member Function Documentation

◆ GetControlParameter()

virtual TIGL_EXPORT const double& tigl::generated::CPACSControlSurfaceStep::GetControlParameter ( ) const
virtual

◆ GetHingeLineRotation()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSControlSurfaceStep::GetHingeLineRotation ( ) const
virtual

◆ GetInnerHingeTranslation() [1/3]

virtual TIGL_EXPORT const boost::optional<CCPACSPoint>& tigl::generated::CPACSControlSurfaceStep::GetInnerHingeTranslation ( ) const
virtual

◆ GetInnerHingeTranslation() [2/3]

virtual TIGL_EXPORT boost::optional<CCPACSPoint>& tigl::generated::CPACSControlSurfaceStep::GetInnerHingeTranslation ( )
virtual

◆ GetInnerHingeTranslation() [3/3]

virtual TIGL_EXPORT CCPACSPoint& tigl::generated::CPACSControlSurfaceStep::GetInnerHingeTranslation ( CreateIfNotExistsTag  )
virtual

◆ GetNextUIDParent() [1/2]

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

◆ GetNextUIDParent() [2/2]

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

◆ GetOuterHingeTranslation() [1/3]

virtual TIGL_EXPORT const boost::optional<CPACSPointXZ>& tigl::generated::CPACSControlSurfaceStep::GetOuterHingeTranslation ( ) const
virtual

◆ GetOuterHingeTranslation() [2/3]

virtual TIGL_EXPORT boost::optional<CPACSPointXZ>& tigl::generated::CPACSControlSurfaceStep::GetOuterHingeTranslation ( )
virtual

◆ GetOuterHingeTranslation() [3/3]

virtual TIGL_EXPORT CPACSPointXZ& tigl::generated::CPACSControlSurfaceStep::GetOuterHingeTranslation ( CreateIfNotExistsTag  )
virtual

◆ GetParent() [1/2]

TIGL_EXPORT CPACSControlSurfaceSteps* tigl::generated::CPACSControlSurfaceStep::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSControlSurfaceSteps* tigl::generated::CPACSControlSurfaceStep::GetParent ( ) const

◆ GetUIDManager() [1/2]

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

◆ GetUIDManager() [2/2]

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

◆ RemoveInnerHingeTranslation()

virtual TIGL_EXPORT void tigl::generated::CPACSControlSurfaceStep::RemoveInnerHingeTranslation ( )
virtual

◆ RemoveOuterHingeTranslation()

virtual TIGL_EXPORT void tigl::generated::CPACSControlSurfaceStep::RemoveOuterHingeTranslation ( )
virtual

◆ SetControlParameter()

virtual TIGL_EXPORT void tigl::generated::CPACSControlSurfaceStep::SetControlParameter ( const double &  value)
virtual

◆ SetHingeLineRotation()

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

◆ WriteCPACS()

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

Field Documentation

◆ m_controlParameter

double tigl::generated::CPACSControlSurfaceStep::m_controlParameter
protected

The control parameter links a generic floating point value to a certain status of a control device (e.g. control surface, landing gear, suction system, brake parachute, ...). See the documentation of the global CPACS-Element for further information.

◆ m_hingeLineRotation

boost::optional<double> tigl::generated::CPACSControlSurfaceStep::m_hingeLineRotation
protected

Positve rotation around the hinge line, heading from the inner to the outer border. Defaults to zero.

◆ m_innerHingeTranslation

boost::optional<CCPACSPoint> tigl::generated::CPACSControlSurfaceStep::m_innerHingeTranslation
protected

Translation of the inner hinge line point within the hinge line coordinate system. Defaults to zero. Not allowed for spoilers!

◆ m_outerHingeTranslation

boost::optional<CPACSPointXZ> tigl::generated::CPACSControlSurfaceStep::m_outerHingeTranslation
protected

Translation of the outer hinge line point within the hinge line coordinate system. Defaults to the values of the inner hinge line point. Not allowed for spoilers!

◆ m_parent

CPACSControlSurfaceSteps* tigl::generated::CPACSControlSurfaceStep::m_parent
protected

◆ m_uidMgr

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