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

CPACS header. More...

#include <CPACSHeader.h>

Public Member Functions

TIGL_EXPORT CPACSHeader (CPACSCpacs *parent)
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetCpacsVersion () const
 
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 CPACSCpacs * GetParent ()
 
TIGL_EXPORT const CPACSCpacs * GetParent () const
 
virtual TIGL_EXPORT const std::string & GetVersion () const
 
virtual TIGL_EXPORT const CPACSVersionInfos & GetVersionInfos () const
 
virtual TIGL_EXPORT CPACSVersionInfos & GetVersionInfos ()
 
virtual TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
 
virtual TIGL_EXPORT void SetCpacsVersion (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetDescription (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetName (const std::string &value)
 
virtual TIGL_EXPORT void SetVersion (const std::string &value)
 
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
 
virtual TIGL_EXPORT ~CPACSHeader ()
 

Protected Attributes

boost::optional< std::string > m_cpacsVersion
 DEPRECATED: Should only be set to allow TiGL to open the file until TiGL is adopted accordingly. Will be replaced by the cpacsVersion element in versionInfos. More...
 
boost::optional< std::string > m_description
 Description of CPACS dataset. More...
 
std::string m_name
 Name of CPACS dataset. More...
 
CPACSCpacs * m_parent
 
std::string m_version
 Version of initial CPACS dataset according to the Semantic Versioning 2.0.0 standard. More...
 
CPACSVersionInfos m_versionInfos
 

Private Member Functions

 CPACSHeader (const CPACSHeader &)=delete
 
 CPACSHeader (CPACSHeader &&)=delete
 
CPACSHeader & operator= (const CPACSHeader &)=delete
 
CPACSHeader & operator= (CPACSHeader &&)=delete
 

Detailed Description

CPACS header.

Header type, containing CPACS dataset description

Constructor & Destructor Documentation

◆ CPACSHeader() [1/3]

TIGL_EXPORT tigl::generated::CPACSHeader::CPACSHeader ( CPACSCpacs *  parent)

◆ ~CPACSHeader()

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

◆ CPACSHeader() [2/3]

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

◆ CPACSHeader() [3/3]

tigl::generated::CPACSHeader::CPACSHeader ( CPACSHeader &&  )
privatedelete

Member Function Documentation

◆ GetCpacsVersion()

virtual TIGL_EXPORT const boost::optional<std::string>& tigl::generated::CPACSHeader::GetCpacsVersion ( ) const
virtual

◆ GetDescription()

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

◆ GetName()

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

◆ GetNextUIDParent() [1/2]

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

◆ GetNextUIDParent() [2/2]

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

◆ GetParent() [1/2]

TIGL_EXPORT CPACSCpacs* tigl::generated::CPACSHeader::GetParent ( )

◆ GetParent() [2/2]

TIGL_EXPORT const CPACSCpacs* tigl::generated::CPACSHeader::GetParent ( ) const

◆ GetVersion()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSHeader::GetVersion ( ) const
virtual

◆ GetVersionInfos() [1/2]

virtual TIGL_EXPORT const CPACSVersionInfos& tigl::generated::CPACSHeader::GetVersionInfos ( ) const
virtual

◆ GetVersionInfos() [2/2]

virtual TIGL_EXPORT CPACSVersionInfos& tigl::generated::CPACSHeader::GetVersionInfos ( )
virtual

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadCPACS()

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

◆ SetCpacsVersion()

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

◆ SetDescription()

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

◆ SetName()

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

◆ SetVersion()

virtual TIGL_EXPORT void tigl::generated::CPACSHeader::SetVersion ( const std::string &  value)
virtual

◆ WriteCPACS()

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

Field Documentation

◆ m_cpacsVersion

boost::optional<std::string> tigl::generated::CPACSHeader::m_cpacsVersion
protected

DEPRECATED: Should only be set to allow TiGL to open the file until TiGL is adopted accordingly. Will be replaced by the cpacsVersion element in versionInfos.

◆ m_description

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

Description of CPACS dataset.

◆ m_name

std::string tigl::generated::CPACSHeader::m_name
protected

Name of CPACS dataset.

◆ m_parent

CPACSCpacs* tigl::generated::CPACSHeader::m_parent
protected

◆ m_version

std::string tigl::generated::CPACSHeader::m_version
protected

Version of initial CPACS dataset according to the Semantic Versioning 2.0.0 standard.

◆ m_versionInfos

CPACSVersionInfos tigl::generated::CPACSHeader::m_versionInfos
protected
The documentation for this class was generated from the following file: