tigl::generated::CPACSCompartment Class Reference

#include <CPACSCompartment.h>

Inheritance diagram for tigl::generated::CPACSCompartment:

Public Member Functions
TIGL_EXPORT	CPACSCompartment (CPACSCompartments *parent, CTiglUIDManager *uidMgr)
virtual TIGL_EXPORT const boost::optional< std::string > &	GetDescription () const
virtual TIGL_EXPORT const boost::optional< double > &	GetDesignVolume () const
virtual TIGL_EXPORT CPACSCompartmentGeometry &	GetGeometry ()
virtual TIGL_EXPORT const CPACSCompartmentGeometry &	GetGeometry () const
virtual TIGL_EXPORT const boost::optional< std::string > &	GetName () const
virtual TIGL_EXPORT CTiglUIDObject *	GetNextUIDParent ()
virtual TIGL_EXPORT const CTiglUIDObject *	GetNextUIDParent () const
TIGL_EXPORT CPACSCompartments *	GetParent ()
TIGL_EXPORT const CPACSCompartments *	GetParent () const
virtual TIGL_EXPORT const boost::optional< 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	SetDesignVolume (const boost::optional< double > &value)
virtual TIGL_EXPORT void	SetName (const boost::optional< std::string > &value)
virtual TIGL_EXPORT void	SetUID (const boost::optional< std::string > &value)
virtual TIGL_EXPORT void	WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
virtual TIGL_EXPORT	~CPACSCompartment ()
Public Member Functions inherited from tigl::CTiglOptUIDObject
boost::optional< std::string >	GetObjectUID () const
virtual	~CTiglOptUIDObject ()=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 compartment.
boost::optional< double >	m_designVolume
	Ideal design volume of the compartment.
CPACSCompartmentGeometry	m_geometry
	Compartment geometry uIDs list.
boost::optional< std::string >	m_name
	Name of the compartment.
CPACSCompartments *	m_parent
boost::optional< std::string >	m_uID
CTiglUIDManager *	m_uidMgr

Private Member Functions
	CPACSCompartment (const CPACSCompartment &)=delete
	CPACSCompartment (CPACSCompartment &&)=delete
CPACSCompartment &	operator= (const CPACSCompartment &)=delete
CPACSCompartment &	operator= (CPACSCompartment &&)=delete

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

Constructor & Destructor Documentation

CPACSCompartment() [1/3]

TIGL_EXPORT tigl::generated::CPACSCompartment::CPACSCompartment	(	CPACSCompartments *	parent,
		CTiglUIDManager *	uidMgr )

~CPACSCompartment()

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

virtual

CPACSCompartment() [2/3]

tigl::generated::CPACSCompartment::CPACSCompartment ( const CPACSCompartment & )

privatedelete

CPACSCompartment() [3/3]

tigl::generated::CPACSCompartment::CPACSCompartment ( CPACSCompartment && )

privatedelete

Member Function Documentation

GetDescription()

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

virtual

GetDesignVolume()

virtual TIGL_EXPORT const boost::optional< double > & tigl::generated::CPACSCompartment::GetDesignVolume ( ) const

virtual

GetGeometry() [1/2]

virtual TIGL_EXPORT CPACSCompartmentGeometry & tigl::generated::CPACSCompartment::GetGeometry ( )

virtual

GetGeometry() [2/2]

virtual TIGL_EXPORT const CPACSCompartmentGeometry & tigl::generated::CPACSCompartment::GetGeometry ( ) const

virtual

GetName()

virtual TIGL_EXPORT const boost::optional< std::string > & tigl::generated::CPACSCompartment::GetName ( ) const

virtual

GetNextUIDParent() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

GetNextUIDParent() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

GetParent() [1/2]

TIGL_EXPORT CPACSCompartments * tigl::generated::CPACSCompartment::GetParent

(

)

GetParent() [2/2]

TIGL_EXPORT const CPACSCompartments * tigl::generated::CPACSCompartment::GetParent

(

)

const

GetUID()

virtual TIGL_EXPORT const boost::optional< std::string > & tigl::generated::CPACSCompartment::GetUID ( ) const

virtual

Implements tigl::CTiglOptUIDObject.

GetUIDManager() [1/2]

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

virtual

Implements tigl::CTiglUIDObject.

GetUIDManager() [2/2]

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

virtual

Implements tigl::CTiglUIDObject.

operator=() [1/2]

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

privatedelete

operator=() [2/2]

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

privatedelete

ReadCPACS()

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

virtual

SetDescription()

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

virtual

SetDesignVolume()

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

virtual

SetName()

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

virtual

SetUID()

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

virtual

WriteCPACS()

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

virtual

Field Documentation

m_description

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

protected

Description of the compartment.

m_designVolume

boost::optional<double> tigl::generated::CPACSCompartment::m_designVolume

protected

Ideal design volume of the compartment.

m_geometry

CPACSCompartmentGeometry tigl::generated::CPACSCompartment::m_geometry

protected

Compartment geometry uIDs list.

m_name

boost::optional<std::string> tigl::generated::CPACSCompartment::m_name

protected

Name of the compartment.

m_parent

CPACSCompartments* tigl::generated::CPACSCompartment::m_parent

protected

m_uID

boost::optional<std::string> tigl::generated::CPACSCompartment::m_uID

protected

m_uidMgr

CTiglUIDManager* tigl::generated::CPACSCompartment::m_uidMgr

protected

---

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

• CPACSCompartment.h