3.3.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 std::string & GetCreator () 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::time_t & GetTimestamp () const
 
virtual TIGL_EXPORT const boost::optional< CPACSUpdates > & GetUpdates () const
 
virtual TIGL_EXPORT boost::optional< CPACSUpdates > & GetUpdates ()
 
virtual TIGL_EXPORT CPACSUpdates & GetUpdates (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT const std::string & GetVersion () const
 
virtual TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath)
 
virtual TIGL_EXPORT void RemoveUpdates ()
 
virtual TIGL_EXPORT void SetCpacsVersion (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetCreator (const 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 SetTimestamp (const std::time_t &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
 CPACS version that the dataset is valid to. The element is optional, since data sets can be valid for several CPACS versions. However, we strongly recommend to assign data sets to a specific CPACS version as far as possible, especially since some tools and libraries (e.g. TiGL) require this specification. More...
 
std::string m_creator
 Creator of initial CPACS dataset. 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::time_t m_timestamp
 Timestamp of initial CPACS dataset creation. More...
 
boost::optional< CPACSUpdates > m_updates
 
std::string m_version
 Version of initial CPACS dataset. More...
 

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

◆ GetCreator()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSHeader::GetCreator ( ) 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

◆ GetTimestamp()

virtual TIGL_EXPORT const std::time_t& tigl::generated::CPACSHeader::GetTimestamp ( ) const
virtual

◆ GetUpdates() [1/3]

virtual TIGL_EXPORT const boost::optional<CPACSUpdates>& tigl::generated::CPACSHeader::GetUpdates ( ) const
virtual

◆ GetUpdates() [2/3]

virtual TIGL_EXPORT boost::optional<CPACSUpdates>& tigl::generated::CPACSHeader::GetUpdates ( )
virtual

◆ GetUpdates() [3/3]

virtual TIGL_EXPORT CPACSUpdates& tigl::generated::CPACSHeader::GetUpdates ( CreateIfNotExistsTag  )
virtual

◆ GetVersion()

virtual TIGL_EXPORT const std::string& tigl::generated::CPACSHeader::GetVersion ( ) const
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

◆ RemoveUpdates()

virtual TIGL_EXPORT void tigl::generated::CPACSHeader::RemoveUpdates ( )
virtual

◆ SetCpacsVersion()

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

◆ SetCreator()

virtual TIGL_EXPORT void tigl::generated::CPACSHeader::SetCreator ( const 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

◆ SetTimestamp()

virtual TIGL_EXPORT void tigl::generated::CPACSHeader::SetTimestamp ( const std::time_t &  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

CPACS version that the dataset is valid to. The element is optional, since data sets can be valid for several CPACS versions. However, we strongly recommend to assign data sets to a specific CPACS version as far as possible, especially since some tools and libraries (e.g. TiGL) require this specification.

◆ m_creator

std::string tigl::generated::CPACSHeader::m_creator
protected

Creator of initial CPACS dataset.

◆ 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_timestamp

std::time_t tigl::generated::CPACSHeader::m_timestamp
protected

Timestamp of initial CPACS dataset creation.

◆ m_updates

boost::optional<CPACSUpdates> tigl::generated::CPACSHeader::m_updates
protected

◆ m_version

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

Version of initial CPACS dataset.

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