SEChangeEnvironmentalConditions Class Reference

#include <SEChangeEnvironmentalConditions.h>

Inherits SEEnvironmentAction.

Public Member Functions
	SEChangeEnvironmentalConditions (Logger *logger=nullptr)
virtual	~SEChangeEnvironmentalConditions ()
virtual void	Clear ()
virtual void	Copy (const SEChangeEnvironmentalConditions &src, const SESubstanceManager &subMgr, bool=false)
virtual bool	IsValid () const
virtual bool	IsActive () const
virtual void	Deactivate ()
virtual bool	HasEnvironmentalConditions () const
virtual SEEnvironmentalConditions &	GetEnvironmentalConditions ()
virtual const SEEnvironmentalConditions *	GetEnvironmentalConditions () const
virtual std::string	GetEnvironmentalConditionsFile () const
virtual void	SetEnvironmentalConditionsFile (const std::string &fileName)
virtual bool	HasEnvironmentalConditionsFile () const
virtual eMergeType	GetMergeType () const
virtual void	SetMergeType (eMergeType m)
virtual void	ToString (std::ostream &str) const
virtual const SEScalar *	GetScalar (const std::string &name)
Public Member Functions inherited from SEEnvironmentAction
	SEEnvironmentAction (Logger *logger)
virtual	~SEEnvironmentAction ()
Public Member Functions inherited from SEAction
	SEAction (Logger *logger)
virtual	~SEAction ()
	SEAction (const SEAction &)=delete
SEAction &	operator= (const SEAction &)=delete
virtual void	Activate ()
virtual std::string	GetComment () const
virtual void	SetComment (const std::string &comment)
virtual bool	HasComment () const
virtual void	InvalidateComment ()
Public Member Functions inherited from Loggable
	Loggable (Logger *logger=nullptr)
	Loggable (std::string const &logfile)
virtual	~Loggable ()
virtual Logger *	GetLogger () const
virtual void	SetLogger (Logger &logger)
virtual void	Debug (std::string const &msg, std::string const &origin=empty) const
virtual void	Debug (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Debug (std::ostream &msg, std::string const &origin=empty) const
virtual void	Info (std::string const &msg, std::string const &origin=empty) const
virtual void	Info (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Info (const std::stringstream &msg, std::string const &origin=empty) const
virtual void	Info (std::ostream &msg, std::string const &origin=empty) const
virtual void	Warning (std::string const &msg, std::string const &origin=empty) const
virtual void	Warning (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Warning (std::ostream &msg, std::string const &origin=empty) const
virtual void	Error (std::string const &msg, std::string const &origin=empty) const
virtual void	Error (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Error (std::ostream &msg, std::string const &origin=empty) const
virtual void	Fatal (std::string const &msg, std::string const &origin=empty) const
virtual void	Fatal (std::stringstream &msg, std::string const &origin=empty) const
virtual void	Fatal (std::ostream &msg, std::string const &origin=empty) const

Protected Attributes
std::string	m_EnvironmentalConditionsFile
SEEnvironmentalConditions *	m_EnvironmentalConditions
eMergeType	m_MergeType
Protected Attributes inherited from SEAction
bool	m_Active = true
std::string	m_Comment
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBEnvironmentAction

Additional Inherited Members
Static Public Member Functions inherited from SEAction
static SEAction *	Copy (const SEAction &, const SESubstanceManager &)
Static Public Attributes inherited from Loggable
static const std::string	empty

Constructor & Destructor Documentation

SEChangeEnvironmentalConditions()

SEChangeEnvironmentalConditions::SEChangeEnvironmentalConditions

(

Logger *

logger = nullptr

)

~SEChangeEnvironmentalConditions()

SEChangeEnvironmentalConditions::~SEChangeEnvironmentalConditions ( )

virtual

Member Function Documentation

Clear()

void SEChangeEnvironmentalConditions::Clear ( )

virtual

Reimplemented from SEEnvironmentAction.

Copy()

void SEChangeEnvironmentalConditions::Copy ( const SEChangeEnvironmentalConditions &  src, const SESubstanceManager &  subMgr, bool  = false  )

virtual

Deactivate()

void SEChangeEnvironmentalConditions::Deactivate ( )

virtual

Reimplemented from SEAction.

GetEnvironmentalConditions() [1/2]

SEEnvironmentalConditions & SEChangeEnvironmentalConditions::GetEnvironmentalConditions ( )

virtual

GetEnvironmentalConditions() [2/2]

const SEEnvironmentalConditions * SEChangeEnvironmentalConditions::GetEnvironmentalConditions ( ) const

virtual

GetEnvironmentalConditionsFile()

std::string SEChangeEnvironmentalConditions::GetEnvironmentalConditionsFile ( ) const

virtual

GetMergeType()

eMergeType SEChangeEnvironmentalConditions::GetMergeType ( ) const

virtual

GetScalar()

const SEScalar * SEChangeEnvironmentalConditions::GetScalar ( const std::string &  name )

virtual

Implements SEAction.

HasEnvironmentalConditions()

bool SEChangeEnvironmentalConditions::HasEnvironmentalConditions ( ) const

virtual

HasEnvironmentalConditionsFile()

bool SEChangeEnvironmentalConditions::HasEnvironmentalConditionsFile ( ) const

virtual

IsActive()

bool SEChangeEnvironmentalConditions::IsActive ( ) const

virtual

Actions can be turned off or on with various data combinations This method will encapsulate that logic in a single function

Reimplemented from SEAction.

IsValid()

bool SEChangeEnvironmentalConditions::IsValid ( ) const

virtual

Test if the action has all data it needs

Reimplemented from SEEnvironmentAction.

SetEnvironmentalConditionsFile()

void SEChangeEnvironmentalConditions::SetEnvironmentalConditionsFile ( const std::string &  fileName )

virtual

SetMergeType()

void SEChangeEnvironmentalConditions::SetMergeType ( eMergeType  m )

virtual

ToString()

void SEChangeEnvironmentalConditions::ToString ( std::ostream &  str ) const

virtual

Implements SEEnvironmentAction.

Friends And Related Function Documentation

PBEnvironmentAction

friend class PBEnvironmentAction

friend

Member Data Documentation

m_EnvironmentalConditions

SEEnvironmentalConditions* SEChangeEnvironmentalConditions::m_EnvironmentalConditions

protected

m_EnvironmentalConditionsFile

std::string SEChangeEnvironmentalConditions::m_EnvironmentalConditionsFile

protected

m_MergeType

eMergeType SEChangeEnvironmentalConditions::m_MergeType

protected