tigl::CCPACSSystemConnection Class Reference

#include <CCPACSSystemConnection.h>

Inheritance diagram for tigl::CCPACSSystemConnection:

Public Member Functions
TIGL_EXPORT	CCPACSSystemConnection (CCPACSSystemConnections *parent, CTiglUIDManager *uidMgr)
TIGL_EXPORT boost::optional< const CCPACSComponent & >	GetSourceComponent () const
	Returns the source component of this system connection, if available as CCPACSComponent.
TIGL_EXPORT boost::optional< const CCPACSComponent & >	GetTargetComponent () const
	Returns the target component of this system connection, if available as CCPACSComponent.
Public Member Functions inherited from tigl::generated::CPACSSystemConnection
TIGL_EXPORT	CPACSSystemConnection (CPACSSystemConnections *parent, CTiglUIDManager *uidMgr)
virtual TIGL_EXPORT const boost::optional< CPACSSystemConnection_connectionType > &	GetConnectionType () const
virtual TIGL_EXPORT boost::optional< CPACSSystemControlDevices > &	GetControlDevices ()
virtual TIGL_EXPORT const boost::optional< CPACSSystemControlDevices > &	GetControlDevices () const
virtual TIGL_EXPORT CPACSSystemControlDevices &	GetControlDevices (CreateIfNotExistsTag)
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 CPACSSystemConnections *	GetParent ()
TIGL_EXPORT const CPACSSystemConnections *	GetParent () const
virtual TIGL_EXPORT CPACSSourceTarget &	GetSource ()
virtual TIGL_EXPORT const CPACSSourceTarget &	GetSource () const
virtual TIGL_EXPORT CPACSSourceTarget &	GetTarget ()
virtual TIGL_EXPORT const CPACSSourceTarget &	GetTarget () const
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	RemoveControlDevices ()
virtual TIGL_EXPORT void	SetConnectionType (const boost::optional< CPACSSystemConnection_connectionType > &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	SetUID (const std::string &value)
virtual TIGL_EXPORT void	WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
virtual TIGL_EXPORT	~CPACSSystemConnection ()
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

Additional Inherited Members
Protected Member Functions inherited from tigl::CTiglUIDObject
	~CTiglUIDObject ()=default
Protected Attributes inherited from tigl::generated::CPACSSystemConnection
boost::optional< CPACSSystemConnection_connectionType >	m_connectionType
	Optional classification of the connection type.
boost::optional< CPACSSystemControlDevices >	m_controlDevices
	Optional control devices defining connection-specific operating states.
boost::optional< std::string >	m_description
	Description.
std::string	m_name
	Name.
CPACSSystemConnections *	m_parent
CPACSSourceTarget	m_source
	Definition of the source of the connection.
CPACSSourceTarget	m_target
	Definition of the target of the connection.
std::string	m_uID
CTiglUIDManager *	m_uidMgr

Constructor & Destructor Documentation

CCPACSSystemConnection()

TIGL_EXPORT tigl::CCPACSSystemConnection::CCPACSSystemConnection	(	CCPACSSystemConnections *	parent,
		CTiglUIDManager *	uidMgr )

Member Function Documentation

GetSourceComponent()

TIGL_EXPORT boost::optional< const CCPACSComponent & > tigl::CCPACSSystemConnection::GetSourceComponent

(

)

const

Returns the source component of this system connection, if available as CCPACSComponent.

This convenience getter resolves the source componentUID and returns the referenced object only if it exists and is of type CCPACSComponent. If the source does not define a componentUID, or if the referenced UID resolves to a different CPACS object type, boost::none is returned.

Returns

Referenced source component as CCPACSComponent, or boost::none.

GetTargetComponent()

TIGL_EXPORT boost::optional< const CCPACSComponent & > tigl::CCPACSSystemConnection::GetTargetComponent

(

)

const

Returns the target component of this system connection, if available as CCPACSComponent.

This convenience getter resolves the target componentUID and returns the referenced object only if it exists and is of type CCPACSComponent. If the target does not define a componentUID, or if the referenced UID resolves to a different CPACS object type, boost::none is returned.

Returns

Referenced target component as CCPACSComponent, or boost::none.

---

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

• CCPACSSystemConnection.h