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

Cuboid. More...

#include <CPACSCuboid.h>

Public Member Functions

TIGL_EXPORT CPACSCuboid (CPACSCuboids *parent, CTiglUIDManager *uidMgr)
virtual TIGL_EXPORT const double & GetDepthY () const
virtual TIGL_EXPORT const double & GetHeightZ () const
virtual TIGL_EXPORT const double & GetLengthX () const
virtual TIGL_EXPORT CTiglUIDObject * GetNextUIDParent ()
virtual TIGL_EXPORT const CTiglUIDObject * GetNextUIDParent () const
TIGL_EXPORT CPACSCuboids * GetParent ()
TIGL_EXPORT const CPACSCuboids * GetParent () const
virtual TIGL_EXPORT boost::optional< CCPACSTransformationSE3 > & GetTransformation ()
virtual TIGL_EXPORT const boost::optional< CCPACSTransformationSE3 > & GetTransformation () const
virtual TIGL_EXPORT CCPACSTransformationSE3 & GetTransformation (CreateIfNotExistsTag)
TIGL_EXPORT CTiglUIDManager & GetUIDManager ()
TIGL_EXPORT const CTiglUIDManager & GetUIDManager () const
virtual TIGL_EXPORT const boost::optional< double > & GetUpperFaceXmax () const
virtual TIGL_EXPORT const boost::optional< double > & GetUpperFaceXmin () const
virtual TIGL_EXPORT const boost::optional< double > & GetUpperFaceYmax () const
virtual TIGL_EXPORT const boost::optional< double > & GetUpperFaceYmin () const
virtual TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
virtual TIGL_EXPORT void RemoveTransformation ()
virtual TIGL_EXPORT void SetDepthY (const double &value)
virtual TIGL_EXPORT void SetHeightZ (const double &value)
virtual TIGL_EXPORT void SetLengthX (const double &value)
virtual TIGL_EXPORT void SetUpperFaceXmax (const boost::optional< double > &value)
virtual TIGL_EXPORT void SetUpperFaceXmin (const boost::optional< double > &value)
virtual TIGL_EXPORT void SetUpperFaceYmax (const boost::optional< double > &value)
virtual TIGL_EXPORT void SetUpperFaceYmin (const boost::optional< double > &value)
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
virtual TIGL_EXPORT ~CPACSCuboid ()

Protected Attributes

double m_depthY
 Depth in y-direction of the lower face [m].
double m_heightZ
 Height in z-direction [m].
double m_lengthX
 Length in x-direction of the lower face [m].
CPACSCuboids * m_parent
boost::optional< CCPACSTransformationSE3 > m_transformation
CTiglUIDManager * m_uidMgr
boost::optional< double > m_upperFaceXmax
 Maximum x-coordinate where the upper face ends [m] (if not defined: equals lengthX).
boost::optional< double > m_upperFaceXmin
 Minimum x-coordinate where the the upper face starts [m] (if not defined: equals 0).
boost::optional< double > m_upperFaceYmax
 Maximum y-coordinate where the upper face ends [m] (if not defined: equals depthY).
boost::optional< double > m_upperFaceYmin
 Minimum y-coordinate where the upper face starts [m] (if not defined: equals 0).

Private Member Functions

 CPACSCuboid (const CPACSCuboid &)=delete
 CPACSCuboid (CPACSCuboid &&)=delete
CPACSCuboid & operator= (const CPACSCuboid &)=delete
CPACSCuboid & operator= (CPACSCuboid &&)=delete

Detailed Description

Cuboid.

The local component coordinate system of the cuboid has its origin at one corner of the lower face. The lower face spans from x = 0 to x = lengthX and from y = 0 to y = depthY at z = 0. The upper face lies at z = heightZ. If no upperFace* values are defined, the upper face equals the lower face and the geometry is a regular cuboid. The optional upperFaceXmin, upperFaceXmax, upperFaceYmin and upperFaceYmax values define the extent of the upper face, allowing tapered or skewed cuboids.

Constructor & Destructor Documentation

◆ CPACSCuboid() [1/3]

TIGL_EXPORT tigl::generated::CPACSCuboid::CPACSCuboid ( CPACSCuboids * parent,
CTiglUIDManager * uidMgr )

◆ ~CPACSCuboid()

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

◆ CPACSCuboid() [2/3]

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

◆ CPACSCuboid() [3/3]

tigl::generated::CPACSCuboid::CPACSCuboid ( CPACSCuboid && )
privatedelete

Member Function Documentation

◆ GetDepthY()

virtual TIGL_EXPORT const double & tigl::generated::CPACSCuboid::GetDepthY ( ) const
virtual

◆ GetHeightZ()

virtual TIGL_EXPORT const double & tigl::generated::CPACSCuboid::GetHeightZ ( ) const
virtual

◆ GetLengthX()

virtual TIGL_EXPORT const double & tigl::generated::CPACSCuboid::GetLengthX ( ) const
virtual

◆ GetNextUIDParent() [1/2]

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

◆ GetNextUIDParent() [2/2]

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

◆ GetParent() [1/2]

TIGL_EXPORT CPACSCuboids * tigl::generated::CPACSCuboid::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSCuboids * tigl::generated::CPACSCuboid::GetParent ( ) const

◆ GetTransformation() [1/3]

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

◆ GetTransformation() [2/3]

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

◆ GetTransformation() [3/3]

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

◆ GetUIDManager() [1/2]

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

◆ GetUIDManager() [2/2]

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

◆ GetUpperFaceXmax()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSCuboid::GetUpperFaceXmax ( ) const
virtual

◆ GetUpperFaceXmin()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSCuboid::GetUpperFaceXmin ( ) const
virtual

◆ GetUpperFaceYmax()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSCuboid::GetUpperFaceYmax ( ) const
virtual

◆ GetUpperFaceYmin()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSCuboid::GetUpperFaceYmin ( ) const
virtual

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

◆ RemoveTransformation()

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

◆ SetDepthY()

virtual TIGL_EXPORT void tigl::generated::CPACSCuboid::SetDepthY ( const double & value)
virtual

◆ SetHeightZ()

virtual TIGL_EXPORT void tigl::generated::CPACSCuboid::SetHeightZ ( const double & value)
virtual

◆ SetLengthX()

virtual TIGL_EXPORT void tigl::generated::CPACSCuboid::SetLengthX ( const double & value)
virtual

◆ SetUpperFaceXmax()

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

◆ SetUpperFaceXmin()

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

◆ SetUpperFaceYmax()

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

◆ SetUpperFaceYmin()

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

◆ WriteCPACS()

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

Field Documentation

◆ m_depthY

double tigl::generated::CPACSCuboid::m_depthY
protected

Depth in y-direction of the lower face [m].

◆ m_heightZ

double tigl::generated::CPACSCuboid::m_heightZ
protected

Height in z-direction [m].

◆ m_lengthX

double tigl::generated::CPACSCuboid::m_lengthX
protected

Length in x-direction of the lower face [m].

◆ m_parent

CPACSCuboids* tigl::generated::CPACSCuboid::m_parent
protected

◆ m_transformation

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

◆ m_uidMgr

CTiglUIDManager* tigl::generated::CPACSCuboid::m_uidMgr
protected

◆ m_upperFaceXmax

boost::optional<double> tigl::generated::CPACSCuboid::m_upperFaceXmax
protected

Maximum x-coordinate where the upper face ends [m] (if not defined: equals lengthX).

◆ m_upperFaceXmin

boost::optional<double> tigl::generated::CPACSCuboid::m_upperFaceXmin
protected

Minimum x-coordinate where the the upper face starts [m] (if not defined: equals 0).

◆ m_upperFaceYmax

boost::optional<double> tigl::generated::CPACSCuboid::m_upperFaceYmax
protected

Maximum y-coordinate where the upper face ends [m] (if not defined: equals depthY).

◆ m_upperFaceYmin

boost::optional<double> tigl::generated::CPACSCuboid::m_upperFaceYmin
protected

Minimum y-coordinate where the upper face starts [m] (if not defined: equals 0).

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