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

Generic system type containing describing the basic dimensions of a system component using simple geometric shapes. More...

#include <CPACSGenericSystem.h>

+ Inheritance diagram for tigl::generated::CPACSGenericSystem:

Public Member Functions

TIGL_EXPORT CPACSGenericSystem (CCPACSGenericSystems *parent, CTiglUIDManager *uidMgr)
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetDescription () const
 
virtual TIGL_EXPORT const boost::optional< CPACSGenericSystem_geometricBaseType > & GetGeometricBaseType () const
 
virtual TIGL_EXPORT const std::string & GetName () const
 
virtual TIGL_EXPORT CTiglUIDObject * GetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObject * GetNextUIDParent () const
 
TIGL_EXPORT CCPACSGenericSystems * GetParent ()
 
TIGL_EXPORT const CCPACSGenericSystems * GetParent () const
 
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 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 SetGeometricBaseType (const boost::optional< CPACSGenericSystem_geometricBaseType > &value)
 
virtual TIGL_EXPORT void SetName (const std::string &value)
 
virtual TIGL_EXPORT void SetSymmetry (const boost::optional< TiglSymmetryAxis > &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 ~CPACSGenericSystem ()
 
- 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
 

Protected Attributes

boost::optional< std::string > m_description
 Description of the system component. More...
 
boost::optional< CPACSGenericSystem_geometricBaseType > m_geometricBaseType
 Enum for selecting the basic shape of the component. More...
 
std::string m_name
 Name of the system component. More...
 
CCPACSGenericSystems * m_parent
 
boost::optional< TiglSymmetryAxis > m_symmetry
 
CCPACSTransformation m_transformation
 
std::string m_uID
 
CTiglUIDManager * m_uidMgr
 

Private Member Functions

 CPACSGenericSystem (const CPACSGenericSystem &)=delete
 
 CPACSGenericSystem (CPACSGenericSystem &&)=delete
 
CPACSGenericSystem & operator= (const CPACSGenericSystem &)=delete
 
CPACSGenericSystem & operator= (CPACSGenericSystem &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from tigl::CTiglUIDObject
 ~CTiglUIDObject ()=default
 

Detailed Description

Generic system type containing describing the basic dimensions of a system component using simple geometric shapes.

The generic base types must be one of the following cone|sphere|cube|cylinder. The origin of the shapes is at the center of volume for cube, sphere and cylinder. Since the cone is constructued from a cylindric shape, its origin is at the same location as the origin of the basic cylinder, although not any longer the center of volume due to scaling of one side. While cube and sphere are symmetrical in all three axis, cylinder and cone are standing upright in the direction of cpacs z-axis. The tip of the cone is located in direction of the positive z-axis. The figure below illustrates the default position and orientation of the different shapes. Note that the cube, cylinder and sphere were moved along the x-axis for demonstration by 2, 4 and 6 meters respectively. For spheres the default diameter is 1m. Cubes have a length of 1m in all three dimensions. Cylinders have a length of 1m and a diameter of 1m for the circular cross section. The cone is a cylinder with the top face scaled down to zero.

See also
geometricBaseType

Constructor & Destructor Documentation

◆ CPACSGenericSystem() [1/3]

TIGL_EXPORT tigl::generated::CPACSGenericSystem::CPACSGenericSystem ( CCPACSGenericSystems *  parent,
CTiglUIDManager *  uidMgr 
)

◆ ~CPACSGenericSystem()

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

◆ CPACSGenericSystem() [2/3]

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

◆ CPACSGenericSystem() [3/3]

tigl::generated::CPACSGenericSystem::CPACSGenericSystem ( CPACSGenericSystem &&  )
privatedelete

Member Function Documentation

◆ GetDescription()

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

◆ GetGeometricBaseType()

virtual TIGL_EXPORT const boost::optional<CPACSGenericSystem_geometricBaseType>& tigl::generated::CPACSGenericSystem::GetGeometricBaseType ( ) const
virtual

◆ GetName()

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

◆ GetNextUIDParent() [1/2]

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

Implements tigl::CTiglUIDObject.

◆ GetNextUIDParent() [2/2]

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

Implements tigl::CTiglUIDObject.

◆ GetParent() [1/2]

TIGL_EXPORT CCPACSGenericSystems* tigl::generated::CPACSGenericSystem::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CCPACSGenericSystems* tigl::generated::CPACSGenericSystem::GetParent ( ) const

◆ GetSymmetry()

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

◆ GetTransformation() [1/2]

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

◆ GetTransformation() [2/2]

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

◆ GetUID()

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

Implements tigl::CTiglReqUIDObject.

◆ GetUIDManager() [1/2]

TIGL_EXPORT CTiglUIDManager& tigl::generated::CPACSGenericSystem::GetUIDManager ( )
virtual

Implements tigl::CTiglUIDObject.

◆ GetUIDManager() [2/2]

TIGL_EXPORT const CTiglUIDManager& tigl::generated::CPACSGenericSystem::GetUIDManager ( ) const
virtual

Implements tigl::CTiglUIDObject.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

◆ SetDescription()

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

◆ SetGeometricBaseType()

virtual TIGL_EXPORT void tigl::generated::CPACSGenericSystem::SetGeometricBaseType ( const boost::optional< CPACSGenericSystem_geometricBaseType > &  value)
virtual

◆ SetName()

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

◆ SetSymmetry()

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

◆ SetUID()

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

◆ WriteCPACS()

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

Field Documentation

◆ m_description

boost::optional<std::string> tigl::generated::CPACSGenericSystem::m_description
protected

Description of the system component.

◆ m_geometricBaseType

boost::optional<CPACSGenericSystem_geometricBaseType> tigl::generated::CPACSGenericSystem::m_geometricBaseType
protected

Enum for selecting the basic shape of the component.

◆ m_name

std::string tigl::generated::CPACSGenericSystem::m_name
protected

Name of the system component.

◆ m_parent

CCPACSGenericSystems* tigl::generated::CPACSGenericSystem::m_parent
protected

◆ m_symmetry

boost::optional<TiglSymmetryAxis> tigl::generated::CPACSGenericSystem::m_symmetry
protected

◆ m_transformation

CCPACSTransformation tigl::generated::CPACSGenericSystem::m_transformation
protected

◆ m_uID

std::string tigl::generated::CPACSGenericSystem::m_uID
protected

◆ m_uidMgr

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