3.5.0-rc1
Loading...
Searching...
No Matches
tigl::generated::CPACSTorus Class Reference

Torus. More...

#include <CPACSTorus.h>

Public Member Functions

TIGL_EXPORT CPACSTorus (CPACSTori *parent, CTiglUIDManager *uidMgr)
virtual TIGL_EXPORT const double & GetMajorRadius () const
virtual TIGL_EXPORT const double & GetMinorRadius () const
virtual TIGL_EXPORT CTiglUIDObjectGetNextUIDParent ()
virtual TIGL_EXPORT const CTiglUIDObjectGetNextUIDParent () const
TIGL_EXPORT CPACSToriGetParent ()
TIGL_EXPORT const CPACSToriGetParent () const
virtual TIGL_EXPORT const boost::optional< double > & GetRevolutionAngle () const
virtual TIGL_EXPORT boost::optional< CCPACSTransformationSE3 > & GetTransformation ()
virtual TIGL_EXPORT const boost::optional< CCPACSTransformationSE3 > & GetTransformation () const
virtual TIGL_EXPORT CCPACSTransformationSE3GetTransformation (CreateIfNotExistsTag)
TIGL_EXPORT CTiglUIDManagerGetUIDManager ()
TIGL_EXPORT const CTiglUIDManagerGetUIDManager () const
virtual TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
virtual TIGL_EXPORT void RemoveTransformation ()
virtual TIGL_EXPORT void SetMajorRadius (const double &value)
virtual TIGL_EXPORT void SetMinorRadius (const double &value)
virtual TIGL_EXPORT void SetRevolutionAngle (const boost::optional< double > &value)
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
virtual TIGL_EXPORT ~CPACSTorus ()

Protected Attributes

double m_majorRadius
 Distance from the local z-axis to the center of the tube [m].
double m_minorRadius
 Radius of the tube cross section [m].
CPACSTorim_parent
boost::optional< double > m_revolutionAngle
 Revolution angle about the local z-axis [rad] (if not defined: equals 2*pi).
boost::optional< CCPACSTransformationSE3m_transformation
CTiglUIDManagerm_uidMgr

Private Member Functions

 CPACSTorus (const CPACSTorus &)=delete
 CPACSTorus (CPACSTorus &&)=delete
CPACSTorusoperator= (const CPACSTorus &)=delete
CPACSTorusoperator= (CPACSTorus &&)=delete

Detailed Description

Torus.

The local component coordinate system of the torus is centered at its geometric center. The symmetry axis coincides with the local z-axis, the reference circle lies in the plane z = 0. The optional revolutionAngle defines the angle of revolution about the local z-axis. If not specified, it defaults to 2*pi, resulting in a full torus.

Constructor & Destructor Documentation

◆ CPACSTorus() [1/3]

TIGL_EXPORT tigl::generated::CPACSTorus::CPACSTorus ( CPACSTori * parent,
CTiglUIDManager * uidMgr )

◆ ~CPACSTorus()

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

◆ CPACSTorus() [2/3]

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

◆ CPACSTorus() [3/3]

tigl::generated::CPACSTorus::CPACSTorus ( CPACSTorus && )
privatedelete

Member Function Documentation

◆ GetMajorRadius()

virtual TIGL_EXPORT const double & tigl::generated::CPACSTorus::GetMajorRadius ( ) const
virtual

◆ GetMinorRadius()

virtual TIGL_EXPORT const double & tigl::generated::CPACSTorus::GetMinorRadius ( ) const
virtual

◆ GetNextUIDParent() [1/2]

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

◆ GetNextUIDParent() [2/2]

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

◆ GetParent() [1/2]

TIGL_EXPORT CPACSTori * tigl::generated::CPACSTorus::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSTori * tigl::generated::CPACSTorus::GetParent ( ) const

◆ GetRevolutionAngle()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSTorus::GetRevolutionAngle ( ) const
virtual

◆ GetTransformation() [1/3]

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

◆ GetTransformation() [2/3]

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

◆ GetTransformation() [3/3]

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

◆ GetUIDManager() [1/2]

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

◆ GetUIDManager() [2/2]

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

◆ RemoveTransformation()

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

◆ SetMajorRadius()

virtual TIGL_EXPORT void tigl::generated::CPACSTorus::SetMajorRadius ( const double & value)
virtual

◆ SetMinorRadius()

virtual TIGL_EXPORT void tigl::generated::CPACSTorus::SetMinorRadius ( const double & value)
virtual

◆ SetRevolutionAngle()

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

◆ WriteCPACS()

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

Field Documentation

◆ m_majorRadius

double tigl::generated::CPACSTorus::m_majorRadius
protected

Distance from the local z-axis to the center of the tube [m].

◆ m_minorRadius

double tigl::generated::CPACSTorus::m_minorRadius
protected

Radius of the tube cross section [m].

◆ m_parent

CPACSTori* tigl::generated::CPACSTorus::m_parent
protected

◆ m_revolutionAngle

boost::optional<double> tigl::generated::CPACSTorus::m_revolutionAngle
protected

Revolution angle about the local z-axis [rad] (if not defined: equals 2*pi).

◆ m_transformation

boost::optional<CCPACSTransformationSE3> tigl::generated::CPACSTorus::m_transformation
protected

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSTorus::m_uidMgr
protected

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