SEEnvironmentAction Class Reference

#include <SEEnvironmentAction.h>

Inherits SEAction.

Inherited by SEChangeEnvironmentalConditions, and SEThermalApplication.

Public Member Functions
	SEEnvironmentAction (Logger *logger)
virtual	~SEEnvironmentAction ()
std::string	GetActionType () const override
void	Clear () override
bool	IsValid () const override
void	Activate () override
bool	IsActive () const override
void	Deactivate () override
Public Member Functions inherited from SEAction
	SEAction (Logger *logger)
virtual	~SEAction ()
	SEAction (const SEAction &)=delete
SEAction &	operator= (const SEAction &)=delete
virtual std::string	GetName () const =0
virtual std::string	GetActionType () const
virtual void	Clear ()
virtual bool	SerializeToString (std::string &dst, eSerializationFormat fmt) const
virtual bool	IsValid () const
virtual void	Activate ()
virtual bool	IsActive () const
virtual void	Deactivate ()
virtual std::string	GetComment () const
virtual void	SetComment (const std::string &comment)
virtual bool	HasComment () const
virtual void	InvalidateComment ()
virtual const SEScalar *	GetScalar (const std::string &name)=0
virtual std::string	ToJSON () const
virtual std::string	ToString () const
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) const
virtual void	Debug (std::stringstream &msg) const
virtual void	Debug (std::ostream &msg) const
virtual void	Info (std::string const &msg) const
virtual void	Info (std::stringstream &msg) const
virtual void	Info (const std::stringstream &msg) const
virtual void	Info (std::ostream &msg) const
virtual void	Warning (std::string const &msg) const
virtual void	Warning (std::stringstream &msg) const
virtual void	Warning (std::ostream &msg) const
virtual void	Error (std::string const &msg) const
virtual void	Error (std::stringstream &msg) const
virtual void	Error (std::ostream &msg) const
virtual void	Fatal (std::string const &msg) const
virtual void	Fatal (std::stringstream &msg) const
virtual void	Fatal (std::ostream &msg) const

Static Public Attributes
static constexpr char const *	ActionType = "Environmental"
Static Public Attributes inherited from SEAction
static constexpr char const *	ActionType = "Action"

Friends
class	PBEnvironmentAction

Additional Inherited Members
Static Public Member Functions inherited from SEAction
static SEAction *	Copy (const SEAction &, const SESubstanceManager &)
static SEAction *	SerializeFromString (const std::string, eSerializationFormat fmt, const SESubstanceManager &)
static std::string	PrettyPrint (const std::string &str)
Protected Attributes inherited from SEAction
bool	m_Active = true
std::string	m_Comment
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Constructor & Destructor Documentation

SEEnvironmentAction()

SEEnvironmentAction::SEEnvironmentAction

(

Logger *

logger

)

~SEEnvironmentAction()

SEEnvironmentAction::~SEEnvironmentAction ( )

virtual

Member Function Documentation

Activate()

void SEEnvironmentAction::Activate ( )

inlineoverridevirtual

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

Reimplemented from SEAction.

Clear()

void SEEnvironmentAction::Clear ( )

inlineoverridevirtual

Reimplemented from SEAction.

Reimplemented in SEThermalApplication.

Deactivate()

void SEEnvironmentAction::Deactivate ( )

inlineoverridevirtual

Reimplemented from SEAction.

Reimplemented in SEThermalApplication.

GetActionType()

std::string SEEnvironmentAction::GetActionType ( ) const

inlineoverridevirtual

Reimplemented from SEAction.

IsActive()

bool SEEnvironmentAction::IsActive ( ) const

inlineoverridevirtual

Reimplemented from SEAction.

Reimplemented in SEThermalApplication.

IsValid()

bool SEEnvironmentAction::IsValid ( ) const

inlineoverridevirtual

Test if the action has all data it needs

Reimplemented from SEAction.

Reimplemented in SEThermalApplication.

Friends And Related Function Documentation

PBEnvironmentAction

friend class PBEnvironmentAction

friend

Member Data Documentation

ActionType

constexpr char const* SEEnvironmentAction::ActionType = "Environmental"

staticconstexpr