3.4.0
tigl::CCPACSRotor Class Reference

#include <CCPACSRotor.h>

+ Inheritance diagram for tigl::CCPACSRotor:

Public Member Functions

TIGL_EXPORT CCPACSRotor (CCPACSRotors *parent, CTiglUIDManager *uidMgr)
 
TIGL_EXPORT TiglGeometricComponentIntent GetComponentIntent () const override
 
TIGL_EXPORT TiglGeometricComponentType GetComponentType () const override
 
TIGL_EXPORT CCPACSConfigurationGetConfiguration () const
 
TIGL_EXPORT TiglRotorType GetDefaultedType () const
 
TIGL_EXPORT std::string GetDefaultedUID () const override
 
TIGL_EXPORT double GetNominalRotationsPerMinute ()
 
TIGL_EXPORT double GetRadius ()
 
TIGL_EXPORT double GetReferenceArea ()
 
TIGL_EXPORT CTiglAttachedRotorBladeGetRotorBlade (int index) const
 
TIGL_EXPORT CCPACSRotorBladeAttachmentGetRotorBladeAttachment (int index) const
 
TIGL_EXPORT int GetRotorBladeAttachmentCount () const
 
TIGL_EXPORT int GetRotorBladeCount () const
 
TIGL_EXPORT PNamedShape GetRotorDisk ()
 
TIGL_EXPORT double GetSolidity ()
 
TIGL_EXPORT double GetSurfaceArea ()
 
TIGL_EXPORT double GetTipSpeed ()
 
TIGL_EXPORT double GetTotalBladePlanformArea ()
 
TIGL_EXPORT CTiglTransformation GetTransformationMatrix () const override
 
TIGL_EXPORT CTiglPoint GetTranslation () const override
 
TIGL_EXPORT double GetVolume ()
 
TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &rotorXPath) override
 
- Public Member Functions inherited from tigl::generated::CPACSRotor
TIGL_EXPORT CPACSRotor (CCPACSRotors *parent, CTiglUIDManager *uidMgr)
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetDescription () const
 
virtual TIGL_EXPORT const std::string & GetName () const
 
virtual TIGL_EXPORT CTiglUIDObjectGetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObjectGetNextUIDParent () const
 
virtual TIGL_EXPORT const boost::optional< double > & GetNominalRotationsPerMinute () const
 
TIGL_EXPORT CCPACSRotorsGetParent ()
 
TIGL_EXPORT const CCPACSRotorsGetParent () const
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetParentUID () const
 
virtual TIGL_EXPORT const CCPACSRotorHubGetRotorHub () const
 
virtual TIGL_EXPORT CCPACSRotorHubGetRotorHub ()
 
virtual TIGL_EXPORT const boost::optional< TiglSymmetryAxis > & GetSymmetry () const
 
virtual TIGL_EXPORT const CCPACSTransformationGetTransformation () const
 
virtual TIGL_EXPORT CCPACSTransformationGetTransformation ()
 
virtual TIGL_EXPORT const boost::optional< CPACSRotor_type > & GetType () const
 
virtual TIGL_EXPORT const std::string & GetUID () const
 
TIGL_EXPORT CTiglUIDManagerGetUIDManager ()
 
TIGL_EXPORT const CTiglUIDManagerGetUIDManager () const
 
virtual TIGL_EXPORT void SetDescription (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetName (const std::string &value)
 
virtual TIGL_EXPORT void SetNominalRotationsPerMinute (const boost::optional< double > &value)
 
virtual TIGL_EXPORT void SetParentUID (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetSymmetry (const boost::optional< TiglSymmetryAxis > &value)
 
virtual TIGL_EXPORT void SetType (const boost::optional< CPACSRotor_type > &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 ~CPACSRotor ()
 
- 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
 
- Public Member Functions inherited from tigl::CTiglRelativelyPositionedComponent
TIGL_EXPORT CTiglRelativelyPositionedComponent (MaybeOptionalPtr< std::string > parentUid, MaybeOptionalPtr< CCPACSTransformation > trans)
 
TIGL_EXPORT CTiglRelativelyPositionedComponent (MaybeOptionalPtr< std::string > parentUid, MaybeOptionalPtr< CCPACSTransformation > trans, boost::optional< TiglSymmetryAxis > *symmetryAxis)
 
TIGL_EXPORT ChildContainerType GetChildren (bool recursive)
 
TIGL_EXPORT boost::optional< const std::string & > GetParentUID () const
 
virtual TIGL_EXPORT CTiglPoint GetRotation () const
 
virtual TIGL_EXPORT CTiglPoint GetScaling () const
 
TIGL_EXPORT TiglSymmetryAxis GetSymmetryAxis () const override
 
virtual TIGL_EXPORT ECPACSTranslationType GetTranslationType () const
 
TIGL_EXPORT void Reset () const
 
TIGL_EXPORT void SetParentUID (const std::string &parentUID)
 
virtual TIGL_EXPORT void SetSymmetryAxis (const TiglSymmetryAxis &axis)
 
virtual TIGL_EXPORT void SetTransformation (const CCPACSTransformation &transform)
 
- Public Member Functions inherited from tigl::CTiglAbstractGeometricComponent
 CTiglAbstractGeometricComponent ()
 
TIGL_EXPORT Bnd_Box const & GetBoundingBox () const
 
virtual TIGL_EXPORT bool GetIsOn (const gp_Pnt &pnt) const
 
TIGL_EXPORT bool GetIsOnMirrored (const gp_Pnt &pnt) const
 
TIGL_EXPORT PNamedShape GetLoft () const override
 
virtual TIGL_EXPORT PNamedShape GetMirroredLoft () const
 
TIGL_EXPORT void Reset () const
 
- Public Member Functions inherited from tigl::ITiglGeometricComponent
virtual ~ITiglGeometricComponent ()
 

Protected Member Functions

PNamedShape BuildLoft () const override
 
void Cleanup ()
 
void Update ()
 
- Protected Member Functions inherited from tigl::CTiglUIDObject
 ~CTiglUIDObject ()=default
 

Private Member Functions

void InvalidateImpl (const boost::optional< std::string > &source) const override
 

Additional Inherited Members

- Public Types inherited from tigl::CTiglRelativelyPositionedComponent
typedef std::vector< CTiglRelativelyPositionedComponent * > ChildContainerType
 
- Protected Types inherited from tigl::CTiglRelativelyPositionedComponent
typedef std::map< int, int > FusedElementsContainerType
 
- Protected Attributes inherited from tigl::generated::CPACSRotor
boost::optional< std::string > m_description
 Description of the rotor. More...
 
std::string m_name
 Name of the rotor. More...
 
boost::optional< double > m_nominalRotationsPerMinute
 Nominal value of the angular rotation speed in rotations per minute (rpm). More...
 
CCPACSRotorsm_parent
 
boost::optional< std::string > m_parentUID
 UID of the part to which the rotor is mounted (if any). The parent of the rotor can e.g. be the fuselage. In each rotorcraft model, there is exactly one part without a parent part (The root of the connection hierarchy). More...
 
CCPACSRotorHub m_rotorHub
 The rotorHub element contains the definition of the rotor hub type and number and azimuth angles of the attached blades and their hinges. The rotor hub position and attitude coincides with the rotor axis system's origin and z axis. More...
 
boost::optional< TiglSymmetryAxism_symmetry
 
CCPACSTransformation m_transformation
 Transformation (scaling, rotation, translation). This element is used to define the position and attitude of the rotor relative to the global or the parent component's axis system. Note that an anisotropical scaling transformation should not be applied to the rotor. More...
 
boost::optional< CPACSRotor_typem_type
 Rotor type. Possible values: "mainRotor" (default), "tailRotor", "fenestron" or "propeller".. More...
 
std::string m_uID
 
CTiglUIDManagerm_uidMgr
 
- Protected Attributes inherited from tigl::CTiglAbstractGeometricComponent
Cache< Bnd_Box, CTiglAbstractGeometricComponentbounding_box
 
Cache< PNamedShape, CTiglAbstractGeometricComponentloft
 

Constructor & Destructor Documentation

◆ CCPACSRotor()

TIGL_EXPORT tigl::CCPACSRotor::CCPACSRotor ( CCPACSRotors parent,
CTiglUIDManager uidMgr 
)

Member Function Documentation

◆ BuildLoft()

PNamedShape tigl::CCPACSRotor::BuildLoft ( ) const
overrideprotectedvirtual

◆ Cleanup()

void tigl::CCPACSRotor::Cleanup ( )
protected

◆ GetComponentIntent()

TIGL_EXPORT TiglGeometricComponentIntent tigl::CCPACSRotor::GetComponentIntent ( ) const
inlineoverridevirtual

◆ GetComponentType()

TIGL_EXPORT TiglGeometricComponentType tigl::CCPACSRotor::GetComponentType ( ) const
inlineoverridevirtual

◆ GetConfiguration()

TIGL_EXPORT CCPACSConfiguration& tigl::CCPACSRotor::GetConfiguration ( ) const

◆ GetDefaultedType()

TIGL_EXPORT TiglRotorType tigl::CCPACSRotor::GetDefaultedType ( ) const

◆ GetDefaultedUID()

TIGL_EXPORT std::string tigl::CCPACSRotor::GetDefaultedUID ( ) const
overridevirtual

◆ GetNominalRotationsPerMinute()

TIGL_EXPORT double tigl::CCPACSRotor::GetNominalRotationsPerMinute ( )

◆ GetRadius()

TIGL_EXPORT double tigl::CCPACSRotor::GetRadius ( )

◆ GetReferenceArea()

TIGL_EXPORT double tigl::CCPACSRotor::GetReferenceArea ( )

◆ GetRotorBlade()

TIGL_EXPORT CTiglAttachedRotorBlade& tigl::CCPACSRotor::GetRotorBlade ( int  index) const

◆ GetRotorBladeAttachment()

TIGL_EXPORT CCPACSRotorBladeAttachment& tigl::CCPACSRotor::GetRotorBladeAttachment ( int  index) const

◆ GetRotorBladeAttachmentCount()

TIGL_EXPORT int tigl::CCPACSRotor::GetRotorBladeAttachmentCount ( ) const

◆ GetRotorBladeCount()

TIGL_EXPORT int tigl::CCPACSRotor::GetRotorBladeCount ( ) const

◆ GetRotorDisk()

TIGL_EXPORT PNamedShape tigl::CCPACSRotor::GetRotorDisk ( )

◆ GetSolidity()

TIGL_EXPORT double tigl::CCPACSRotor::GetSolidity ( )

◆ GetSurfaceArea()

TIGL_EXPORT double tigl::CCPACSRotor::GetSurfaceArea ( )

◆ GetTipSpeed()

TIGL_EXPORT double tigl::CCPACSRotor::GetTipSpeed ( )

◆ GetTotalBladePlanformArea()

TIGL_EXPORT double tigl::CCPACSRotor::GetTotalBladePlanformArea ( )

◆ GetTransformationMatrix()

TIGL_EXPORT CTiglTransformation tigl::CCPACSRotor::GetTransformationMatrix ( ) const
overridevirtual

◆ GetTranslation()

TIGL_EXPORT CTiglPoint tigl::CCPACSRotor::GetTranslation ( ) const
overridevirtual

◆ GetVolume()

TIGL_EXPORT double tigl::CCPACSRotor::GetVolume ( )

◆ InvalidateImpl()

void tigl::CCPACSRotor::InvalidateImpl ( const boost::optional< std::string > &  source) const
overrideprivatevirtual

Reimplemented from tigl::CTiglUIDObject.

◆ ReadCPACS()

TIGL_EXPORT void tigl::CCPACSRotor::ReadCPACS ( const TixiDocumentHandle &  tixiHandle,
const std::string &  rotorXPath 
)
overridevirtual

Reimplemented from tigl::generated::CPACSRotor.

◆ Update()

void tigl::CCPACSRotor::Update ( )
protected

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