SEConsumeNutrients Class Reference

#include <SEConsumeNutrients.h>

Inherits SEPatientAction.

Public Member Functions
	SEConsumeNutrients (Logger *logger=nullptr)
virtual	~SEConsumeNutrients ()
virtual std::string	GetName () const
virtual void	Clear ()
virtual void	Copy (const SEConsumeNutrients &src, bool=false)
virtual bool	IsValid () const
virtual bool	IsActive () const
virtual void	Deactivate ()
bool	HasNutrition () const
SENutrition &	GetNutrition ()
const SENutrition *	GetNutrition () const
virtual std::string	GetNutritionFile () const
virtual void	SetNutritionFile (const std::string &fileName)
virtual bool	HasNutritionFile () const
virtual const SEScalar *	GetScalar (const std::string &name)
Public Member Functions inherited from SEPatientAction
	SEPatientAction (Logger *logger=nullptr)
virtual	~SEPatientAction ()
virtual std::string	GetActionType () const
virtual void	Clear ()
virtual bool	IsValid () const
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 bool	IsActive () const
virtual void	Activate ()
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 *	Name = "Consume Nutrients"
Static Public Attributes inherited from SEPatientAction
static constexpr char const *	ActionType = "Patient"
Static Public Attributes inherited from SEAction
static constexpr char const *	ActionType = "Action"

Protected Attributes
SENutrition *	m_Nutrition
std::string	m_NutritionFile
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	PBPatientAction

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)

Constructor & Destructor Documentation

SEConsumeNutrients()

SEConsumeNutrients::SEConsumeNutrients

(

Logger *

logger = nullptr

)

~SEConsumeNutrients()

SEConsumeNutrients::~SEConsumeNutrients ( )

virtual

Member Function Documentation

Clear()

void SEConsumeNutrients::Clear ( )

virtual

Reimplemented from SEPatientAction.

Copy()

void SEConsumeNutrients::Copy ( const SEConsumeNutrients &  src, bool  = false  )

virtual

Deactivate()

void SEConsumeNutrients::Deactivate ( )

virtual

Reimplemented from SEAction.

GetName()

virtual std::string SEConsumeNutrients::GetName ( ) const

inlinevirtual

Implements SEAction.

GetNutrition() [1/2]

SENutrition & SEConsumeNutrients::GetNutrition

(

)

GetNutrition() [2/2]

const SENutrition * SEConsumeNutrients::GetNutrition

(

)

const

GetNutritionFile()

std::string SEConsumeNutrients::GetNutritionFile ( ) const

virtual

GetScalar()

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

virtual

Implements SEAction.

HasNutrition()

bool SEConsumeNutrients::HasNutrition

(

)

const

HasNutritionFile()

bool SEConsumeNutrients::HasNutritionFile ( ) const

virtual

IsActive()

bool SEConsumeNutrients::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 SEConsumeNutrients::IsValid ( ) const

virtual

Test if the action has all data it needs

Reimplemented from SEPatientAction.

SetNutritionFile()

void SEConsumeNutrients::SetNutritionFile ( const std::string &  fileName )

virtual

Friends And Related Function Documentation

PBPatientAction

friend class PBPatientAction

friend

Member Data Documentation

m_Nutrition

SENutrition* SEConsumeNutrients::m_Nutrition

protected

m_NutritionFile

std::string SEConsumeNutrients::m_NutritionFile

protected

Name

constexpr char const* SEConsumeNutrients::Name = "Consume Nutrients"

staticconstexpr