Rotor type, containing a rotor (main rotor, tail rotor, fenestron, propeller,...) of an rotorcraft model. More...

#include <CPACSRotor.h>

Inheritance diagram for tigl::generated::CPACSRotor:

Public Member Functions
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 CTiglUIDObject *	GetNextUIDParent ()

virtual TIGL_EXPORT const CTiglUIDObject *	GetNextUIDParent () const

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

TIGL_EXPORT CCPACSRotors *	GetParent ()

TIGL_EXPORT const CCPACSRotors *	GetParent () const

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

virtual TIGL_EXPORT const CCPACSRotorHub &	GetRotorHub () const

virtual TIGL_EXPORT CCPACSRotorHub &	GetRotorHub ()

virtual TIGL_EXPORT const boost::optional< TiglSymmetryAxis > &	GetSymmetry () const

virtual TIGL_EXPORT const CCPACSTransformation &	GetTransformation () const

virtual TIGL_EXPORT CCPACSTransformation &	GetTransformation ()

virtual TIGL_EXPORT const boost::optional< CPACSRotor_type > &	GetType () 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	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

Protected Attributes
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...

CCPACSRotors *	m_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< TiglSymmetryAxis >	m_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_type >	m_type
	Rotor type. Possible values: "mainRotor" (default), "tailRotor", "fenestron" or "propeller".. More...

std::string	m_uID

CTiglUIDManager *	m_uidMgr

Private Member Functions
	CPACSRotor (const CPACSRotor &)=delete

	CPACSRotor (CPACSRotor &&)=delete

TIGL_EXPORT const CTiglUIDObject *	GetNextUIDObject () const final

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

CPACSRotor &	operator= (const CPACSRotor &)=delete

CPACSRotor &	operator= (CPACSRotor &&)=delete

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

Detailed Description

Rotor type, containing a rotor (main rotor, tail rotor, fenestron, propeller,...) of an rotorcraft model.

Rotor type, containing a rotor (e.g. main rotor, tail rotor, fenestron, propeller,...) definition of a rotorcraft model. The position and attitude of the rotor is defined using the transformation element. The following image shows the CPACS conventions for the orientation of rotors and rotor axis systems:

See also: rotor_cs01 The origin coincides with the center of rotation. The z-axis corresponds to the axis of rotation and thus coincides with the rotor shaft centerline. It Points in the main thrust direction of the rotor (usually upwards for a main rotor, forwards for a propeller). The x-axis points from nose to tail (usually rearwards for main and tail rotors, upwards for a propeller). The y-axis completes the right-handed orthogonal coordinate system. Rotor hub attributes, hinges and references to attached rotor blades are defined in the rotorHub element. Note that rotor blade geometries are only referenced and not defined in the child nodes of the rotor element. Refer to the documentation of rotorBladesType ( Empty::T/rotorBladesType ) and wingType ( Empty::T/wingType ) for information on the definition of rotor blade geometries. The following figure shows the transformations to be applied to rotorBlade geometries to visualize them in the rotor frames for a given state (each rotor: rotorAzimuth given, each hinge: hingeDeflection given):; rotor_transformation

Constructor & Destructor Documentation

◆ CPACSRotor() [1/3]

TIGL_EXPORT tigl::generated::CPACSRotor::CPACSRotor	(	CCPACSRotors *	parent,
		CTiglUIDManager *	uidMgr
	)

◆ ~CPACSRotor()

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

virtual

◆ CPACSRotor() [2/3]

tigl::generated::CPACSRotor::CPACSRotor ( const CPACSRotor & )

privatedelete

◆ CPACSRotor() [3/3]

tigl::generated::CPACSRotor::CPACSRotor ( CPACSRotor && )

privatedelete

Member Function Documentation

◆ GetDescription()

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

virtual

◆ GetName()

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

virtual

◆ GetNextUIDObject()

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

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ GetNextUIDParent() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetNextUIDParent() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetNominalRotationsPerMinute()

virtual TIGL_EXPORT const boost::optional<double>& tigl::generated::CPACSRotor::GetNominalRotationsPerMinute ( ) const

virtual

◆ GetParent() [1/2]

TIGL_EXPORT CCPACSRotors* tigl::generated::CPACSRotor::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CCPACSRotors* tigl::generated::CPACSRotor::GetParent ( ) const

◆ GetParentUID()

virtual TIGL_EXPORT const boost::optional<std::string>& tigl::generated::CPACSRotor::GetParentUID ( ) const

virtual

◆ GetRotorHub() [1/2]

virtual TIGL_EXPORT const CCPACSRotorHub& tigl::generated::CPACSRotor::GetRotorHub ( ) const

virtual

◆ GetRotorHub() [2/2]

virtual TIGL_EXPORT CCPACSRotorHub& tigl::generated::CPACSRotor::GetRotorHub ( )

virtual

◆ GetSymmetry()

virtual TIGL_EXPORT const boost::optional<TiglSymmetryAxis>& tigl::generated::CPACSRotor::GetSymmetry ( ) const

virtual

◆ GetTransformation() [1/2]

virtual TIGL_EXPORT const CCPACSTransformation& tigl::generated::CPACSRotor::GetTransformation ( ) const

virtual

◆ GetTransformation() [2/2]

virtual TIGL_EXPORT CCPACSTransformation& tigl::generated::CPACSRotor::GetTransformation ( )

virtual

◆ GetType()

virtual TIGL_EXPORT const boost::optional<CPACSRotor_type>& tigl::generated::CPACSRotor::GetType ( ) const

virtual

◆ GetUID()

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

virtual

Implements tigl::CTiglReqUIDObject.

◆ GetUIDManager() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetUIDManager() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ NotifyUIDChange()

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

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ operator=() [1/2]

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

privatedelete

◆ operator=() [2/2]

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

privatedelete

◆ ReadCPACS()

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

virtual

Reimplemented in tigl::CCPACSRotor.

◆ SetDescription()

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

virtual

◆ SetName()

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

virtual

◆ SetNominalRotationsPerMinute()

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

virtual

◆ SetParentUID()

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

virtual

◆ SetSymmetry()

virtual TIGL_EXPORT void tigl::generated::CPACSRotor::SetSymmetry ( const boost::optional< TiglSymmetryAxis > & value )

virtual

◆ SetType()

virtual TIGL_EXPORT void tigl::generated::CPACSRotor::SetType ( const boost::optional< CPACSRotor_type > & value )

virtual

◆ SetUID()

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

virtual

◆ WriteCPACS()

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

virtual

Field Documentation

◆ m_description

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

protected

Description of the rotor.

◆ m_name

std::string tigl::generated::CPACSRotor::m_name

protected

Name of the rotor.

◆ m_nominalRotationsPerMinute

boost::optional<double> tigl::generated::CPACSRotor::m_nominalRotationsPerMinute

protected

Nominal value of the angular rotation speed in rotations per minute (rpm).

◆ m_parent

CCPACSRotors* tigl::generated::CPACSRotor::m_parent

protected

◆ m_parentUID

boost::optional<std::string> tigl::generated::CPACSRotor::m_parentUID

protected

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).

◆ m_rotorHub

CCPACSRotorHub tigl::generated::CPACSRotor::m_rotorHub

protected

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.

◆ m_symmetry

boost::optional<TiglSymmetryAxis> tigl::generated::CPACSRotor::m_symmetry

protected

◆ m_transformation

CCPACSTransformation tigl::generated::CPACSRotor::m_transformation

protected

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.

◆ m_type

boost::optional<CPACSRotor_type> tigl::generated::CPACSRotor::m_type

protected

Rotor type. Possible values: "mainRotor" (default), "tailRotor", "fenestron" or "propeller"..

◆ m_uID

std::string tigl::generated::CPACSRotor::m_uID

protected

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSRotor::m_uidMgr

protected

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

CPACSRotor.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CPACSRotor() [1/3]

◆ ~CPACSRotor()

◆ CPACSRotor() [2/3]

◆ CPACSRotor() [3/3]

Member Function Documentation

◆ GetDescription()

◆ GetName()

◆ GetNextUIDObject()

◆ GetNextUIDParent() [1/2]

◆ GetNextUIDParent() [2/2]

◆ GetNominalRotationsPerMinute()

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetParentUID()

◆ GetRotorHub() [1/2]

◆ GetRotorHub() [2/2]

◆ GetSymmetry()

◆ GetTransformation() [1/2]

◆ GetTransformation() [2/2]

◆ GetType()

◆ GetUID()

◆ GetUIDManager() [1/2]

◆ GetUIDManager() [2/2]

◆ NotifyUIDChange()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadCPACS()

◆ SetDescription()

◆ SetName()

◆ SetNominalRotationsPerMinute()

◆ SetParentUID()

◆ SetSymmetry()

◆ SetType()

◆ SetUID()

◆ WriteCPACS()

Field Documentation

◆ m_description

◆ m_name

◆ m_nominalRotationsPerMinute

◆ m_parent

◆ m_parentUID

◆ m_rotorHub

◆ m_symmetry

◆ m_transformation

◆ m_type

◆ m_uID

◆ m_uidMgr