Documentation for OpenFLUID 2.2.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
openfluid::machine::WareContainer< SignatureType > Class Template Reference

Detailed Description

template<class SignatureType>
class openfluid::machine::WareContainer< SignatureType >
Template Parameters
SignatureTypethe type of the signature to hold in the container

#include <machine/WareContainer.hpp>

Public Member Functions

 WareContainer ()=delete
 
 WareContainer (const WareContainer &)=delete
 
 WareContainer (WareContainer &&)=default
 
WareContainer & operator= (const WareContainer &)=delete
 
WareContainer & operator= (WareContainer &&)=default
 
virtual ~WareContainer ()=default
 
 WareContainer (openfluid::ware::WareType WType)
 
openfluid::ware::WareType getWareType () const
 
std::string getPath () const
 
void setPath (const std::string &Path)
 
UUID_t getLinkUID () const
 
void setLinkUID (const UUID_t &UID)
 
bool isValid () const
 
void validate ()
 
std::string getMessage () const
 
void setMessage (const std::string &Message)
 
const std::unique_ptr< SignatureType > & signature () const
 
bool hasSignature () const
 
void setSignature (SignatureType *Signature)
 
bool isGhost () const
 
void setGhost ()
 

Constructor & Destructor Documentation

◆ WareContainer() [1/4]

template<class SignatureType >
openfluid::machine::WareContainer< SignatureType >::WareContainer ( )
delete

◆ WareContainer() [2/4]

template<class SignatureType >
openfluid::machine::WareContainer< SignatureType >::WareContainer ( const WareContainer< SignatureType > &  )
delete

◆ WareContainer() [3/4]

template<class SignatureType >
openfluid::machine::WareContainer< SignatureType >::WareContainer ( WareContainer< SignatureType > &&  )
default

◆ ~WareContainer()

template<class SignatureType >
virtual openfluid::machine::WareContainer< SignatureType >::~WareContainer ( )
virtualdefault

◆ WareContainer() [4/4]

template<class SignatureType >
openfluid::machine::WareContainer< SignatureType >::WareContainer ( openfluid::ware::WareType  WType)
inline

Member Function Documentation

◆ getLinkUID()

template<class SignatureType >
UUID_t openfluid::machine::WareContainer< SignatureType >::getLinkUID ( ) const
inline

Returns the link UID for parameterization UI

Returns
the link UID

◆ getMessage()

template<class SignatureType >
std::string openfluid::machine::WareContainer< SignatureType >::getMessage ( ) const
inline

Returns the optional message aosciated to the container

Returns
the message

◆ getPath()

template<class SignatureType >
std::string openfluid::machine::WareContainer< SignatureType >::getPath ( ) const
inline

Returns the path of the ware

Returns
The ware path

◆ getWareType()

template<class SignatureType >
openfluid::ware::WareType openfluid::machine::WareContainer< SignatureType >::getWareType ( ) const
inline

Returns the ware type

Returns
The ware type

◆ hasSignature()

template<class SignatureType >
bool openfluid::machine::WareContainer< SignatureType >::hasSignature ( ) const
inline

Indicates if a signature is held by the container

Returns
true if a signature is held

◆ isGhost()

template<class SignatureType >
bool openfluid::machine::WareContainer< SignatureType >::isGhost ( ) const
inline

Returns true if the ware is a ghost

Returns
true if the ware is a ghost

◆ isValid()

template<class SignatureType >
bool openfluid::machine::WareContainer< SignatureType >::isValid ( ) const
inline

Gives the validation status

Returns
true if the conrtainer is valid

◆ operator=() [1/2]

template<class SignatureType >
WareContainer & openfluid::machine::WareContainer< SignatureType >::operator= ( const WareContainer< SignatureType > &  )
delete

◆ operator=() [2/2]

template<class SignatureType >
WareContainer & openfluid::machine::WareContainer< SignatureType >::operator= ( WareContainer< SignatureType > &&  )
default

◆ setGhost()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::setGhost ( )
inline

Marks the ware as ghost

Note
a container marked as ghost cannot be "unghosted"

◆ setLinkUID()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::setLinkUID ( const UUID_t &  UID)
inline

Sets the link UID for parameterization UI

Parameters
[in]UIDthe UID
Exceptions
openfluid::base::FrameworkExceptionif UID is already set

◆ setMessage()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::setMessage ( const std::string &  Message)
inline

Sets the optional message aosciated to the container

Parameters
[in]Messagethe message

◆ setPath()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::setPath ( const std::string &  Path)
inline

Sets the path of the ware on disk

Parameters
[in]Paththe path
Exceptions
openfluid::base::FrameworkExceptionif path is already set

◆ setSignature()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::setSignature ( SignatureType *  Signature)
inline

Sets the signature

Exceptions
openfluid::base::FrameworkExceptionif signature is already set
Note
after using this method, the signature is owned by the container

◆ signature()

template<class SignatureType >
const std::unique_ptr< SignatureType > & openfluid::machine::WareContainer< SignatureType >::signature ( ) const
inline

Returns a const reference to the signature as a unique pointer

Returns
the signature held in the container

◆ validate()

template<class SignatureType >
void openfluid::machine::WareContainer< SignatureType >::validate ( )
inline

Sets the container as valid

Note
a container cannot be invalidated
The documentation for this class was generated from the following file: