Component. More...

#include <CPACSComponent.h>

Inheritance diagram for tigl::generated::CPACSComponent:

Public Member Functions
TIGL_EXPORT	CPACSComponent (CPACSComponents 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
TIGL_EXPORT CPACSComponents *	GetParent ()
TIGL_EXPORT const CPACSComponents *	GetParent () const
virtual TIGL_EXPORT const boost::optional< std::string > &	GetParentUID () const
virtual TIGL_EXPORT boost::optional< CPACSUIDSequence > &	GetStructuralMountUIDs ()
virtual TIGL_EXPORT const boost::optional< CPACSUIDSequence > &	GetStructuralMountUIDs () const
virtual TIGL_EXPORT CPACSUIDSequence &	GetStructuralMountUIDs (CreateIfNotExistsTag)
virtual TIGL_EXPORT const std::string &	GetSystemElementUID () const
virtual TIGL_EXPORT boost::optional< CCPACSTransformationSE3 > &	GetTransformation ()
virtual TIGL_EXPORT const boost::optional< CCPACSTransformationSE3 > &	GetTransformation () const
virtual TIGL_EXPORT CCPACSTransformationSE3 &	GetTransformation (CreateIfNotExistsTag)
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	RemoveStructuralMountUIDs ()
virtual TIGL_EXPORT void	RemoveTransformation ()
virtual TIGL_EXPORT void	SetDescription (const boost::optional< std::string > &value)
virtual TIGL_EXPORT void	SetName (const std::string &value)
virtual TIGL_EXPORT void	SetParentUID (const boost::optional< std::string > &value)
virtual TIGL_EXPORT void	SetSystemElementUID (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	~CPACSComponent ()
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.
std::string	m_name
	Name.
CPACSComponents *	m_parent
boost::optional< std::string >	m_parentUID
	Optional UID reference to the parent object used for relative positioning.
boost::optional< CPACSUIDSequence >	m_structuralMountUIDs
	UIDs of the structural mounts as defined in the fuselages or wings (see structuralMountType for further details).
std::string	m_systemElementUID
	UID reference to the predefined system element.
boost::optional< CCPACSTransformationSE3 >	m_transformation
	Optional rigid transformation defining the component position and orientation.
std::string	m_uID
CTiglUIDManager *	m_uidMgr

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

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

Detailed Description

Component.

A component represents a physically existing instance of a predefined system element within a generic system. It references the corresponding element definition via systemElementUID , from which its geometry, geometry representation, and mass-related properties are derived. A component may be explicitly positioned by a transformation and, optionally, by a parent reference. If no transformation is defined, the component is considered unpositioned. In that case, local geometry and local mass properties may still be available, but the global center of gravity cannot be evaluated. The referenced system element may define either a physical or an envelope representation. Mass properties are taken from the referenced element definition if available; otherwise they may be derived from density and geometry.

Constructor & Destructor Documentation

◆ CPACSComponent() [1/3]

TIGL_EXPORT tigl::generated::CPACSComponent::CPACSComponent	(	CPACSComponents *	parent,
		CTiglUIDManager *	uidMgr )

◆ ~CPACSComponent()

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

virtual

◆ CPACSComponent() [2/3]

tigl::generated::CPACSComponent::CPACSComponent ( const CPACSComponent & )

privatedelete

◆ CPACSComponent() [3/3]

tigl::generated::CPACSComponent::CPACSComponent ( CPACSComponent && )

privatedelete

Member Function Documentation

◆ GetDescription()

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

virtual

◆ GetName()

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

virtual

◆ GetNextUIDObject()

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

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ GetNextUIDParent() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetNextUIDParent() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetParent() [1/2]

TIGL_EXPORT CPACSComponents * tigl::generated::CPACSComponent::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSComponents * tigl::generated::CPACSComponent::GetParent ( ) const

◆ GetParentUID()

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

virtual

◆ GetStructuralMountUIDs() [1/3]

virtual TIGL_EXPORT boost::optional< CPACSUIDSequence > & tigl::generated::CPACSComponent::GetStructuralMountUIDs ( )

virtual

◆ GetStructuralMountUIDs() [2/3]

virtual TIGL_EXPORT const boost::optional< CPACSUIDSequence > & tigl::generated::CPACSComponent::GetStructuralMountUIDs ( ) const

virtual

◆ GetStructuralMountUIDs() [3/3]

virtual TIGL_EXPORT CPACSUIDSequence & tigl::generated::CPACSComponent::GetStructuralMountUIDs ( CreateIfNotExistsTag )

virtual

◆ GetSystemElementUID()

virtual TIGL_EXPORT const std::string & tigl::generated::CPACSComponent::GetSystemElementUID ( ) const

virtual

◆ GetTransformation() [1/3]

virtual TIGL_EXPORT boost::optional< CCPACSTransformationSE3 > & tigl::generated::CPACSComponent::GetTransformation ( )

virtual

◆ GetTransformation() [2/3]

virtual TIGL_EXPORT const boost::optional< CCPACSTransformationSE3 > & tigl::generated::CPACSComponent::GetTransformation ( ) const

virtual

◆ GetTransformation() [3/3]

virtual TIGL_EXPORT CCPACSTransformationSE3 & tigl::generated::CPACSComponent::GetTransformation ( CreateIfNotExistsTag )

virtual

◆ GetUID()

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

virtual

Implements tigl::CTiglReqUIDObject.

◆ GetUIDManager() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ GetUIDManager() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

◆ NotifyUIDChange()

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

finalprivatevirtual

Implements tigl::ITiglUIDRefObject.

◆ operator=() [1/2]

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

privatedelete

◆ operator=() [2/2]

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

privatedelete

◆ ReadCPACS()

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

virtual

Reimplemented in tigl::CCPACSComponent.

◆ RemoveStructuralMountUIDs()

virtual TIGL_EXPORT void tigl::generated::CPACSComponent::RemoveStructuralMountUIDs ( )

virtual

◆ RemoveTransformation()

virtual TIGL_EXPORT void tigl::generated::CPACSComponent::RemoveTransformation ( )

virtual

◆ SetDescription()

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

virtual

◆ SetName()

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

virtual

◆ SetParentUID()

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

virtual

◆ SetSystemElementUID()

virtual TIGL_EXPORT void tigl::generated::CPACSComponent::SetSystemElementUID ( const std::string & value )

virtual

◆ SetUID()

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

virtual

◆ WriteCPACS()

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

virtual

Field Documentation

◆ m_description

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

protected

Description.

◆ m_name

std::string tigl::generated::CPACSComponent::m_name

protected

Name.

◆ m_parent

CPACSComponents* tigl::generated::CPACSComponent::m_parent

protected

◆ m_parentUID

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

protected

Optional UID reference to the parent object used for relative positioning.

◆ m_structuralMountUIDs

boost::optional<CPACSUIDSequence> tigl::generated::CPACSComponent::m_structuralMountUIDs

protected

UIDs of the structural mounts as defined in the fuselages or wings (see structuralMountType for further details).

◆ m_systemElementUID

std::string tigl::generated::CPACSComponent::m_systemElementUID

protected

UID reference to the predefined system element.

◆ m_transformation

boost::optional<CCPACSTransformationSE3> tigl::generated::CPACSComponent::m_transformation

protected

Optional rigid transformation defining the component position and orientation.

◆ m_uID

std::string tigl::generated::CPACSComponent::m_uID

protected

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSComponent::m_uidMgr

protected

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

CPACSComponent.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CPACSComponent() [1/3]

◆ ~CPACSComponent()

◆ CPACSComponent() [2/3]

◆ CPACSComponent() [3/3]

Member Function Documentation

◆ GetDescription()

◆ GetName()

◆ GetNextUIDObject()

◆ GetNextUIDParent() [1/2]

◆ GetNextUIDParent() [2/2]

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetParentUID()

◆ GetStructuralMountUIDs() [1/3]

◆ GetStructuralMountUIDs() [2/3]

◆ GetStructuralMountUIDs() [3/3]

◆ GetSystemElementUID()

◆ GetTransformation() [1/3]

◆ GetTransformation() [2/3]

◆ GetTransformation() [3/3]

◆ GetUID()

◆ GetUIDManager() [1/2]

◆ GetUIDManager() [2/2]

◆ NotifyUIDChange()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadCPACS()

◆ RemoveStructuralMountUIDs()

◆ RemoveTransformation()

◆ SetDescription()

◆ SetName()

◆ SetParentUID()

◆ SetSystemElementUID()

◆ SetUID()

◆ WriteCPACS()

Field Documentation

◆ m_description

◆ m_name

◆ m_parent

◆ m_parentUID

◆ m_structuralMountUIDs

◆ m_systemElementUID

◆ m_transformation

◆ m_uID

◆ m_uidMgr