SETimedStabilization Class Reference

#include <SETimedStabilization.h>

Inheritance diagram for SETimedStabilization:

Public Member Functions
	SETimedStabilization (Logger *logger)
virtual	~SETimedStabilization ()
void	Clear () override
bool	SerializeToString (std::string &output, eSerializationFormat m) const
bool	SerializeToFile (const std::string &filename) const
bool	SerializeFromString (const std::string &src, eSerializationFormat m)
bool	SerializeFromFile (const std::string &filename)
bool	Stabilize (Controller &engine, const std::string &criteria) override
bool	StabilizeConditions (Controller &engine, const SEConditionManager &conditions) override
bool	HasConvergenceCriteria (const std::string &name) const override
void	RemoveConvergenceCriteria (const std::string &name) override
virtual const std::map< std::string, SEScalarTime * > &	GetConvergenceCriterias () const
virtual SEScalarTime &	GetConvergenceCriteria (const std::string &name)
virtual const SEScalarTime *	GetConvergenceCriteria (const std::string &name) const
Public Member Functions inherited from SEEngineStabilization
	SEEngineStabilization (Logger *logger)
virtual	~SEEngineStabilization ()
virtual void	LogProgress (bool b)
virtual void	CancelStabilization ()
virtual void	TrackStabilization (eSwitch state)
virtual bool	IsTrackingStabilization ()
virtual bool	HasStabilizationDuration ()
virtual SEScalarTime &	GetStabilizationDuration ()
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

Protected Member Functions
virtual bool	Stabilize (Controller &engine, const SEScalarTime &time)

Protected Attributes
std::map< std::string, SEScalarTime * >	m_ConvergenceCriteria
Protected Attributes inherited from SEEngineStabilization
bool	m_Cancelled
bool	m_LogProgress
eSwitch	m_TrackingStabilization
std::stringstream	m_ss
SEScalarTime *	m_StabilizationDuration
std::vector< const SECondition * >	m_Conditions
Protected Attributes inherited from Loggable
bool	myLogger
Logger *	m_Logger

Friends
class	PBEngine

Additional Inherited Members
Static Public Attributes inherited from SEEngineStabilization
static constexpr char const *	Resting = "Resting"
static constexpr char const *	AdvanceUntilStable = "AdvanceUntilStable"

Constructor & Destructor Documentation

SETimedStabilization()

SETimedStabilization::SETimedStabilization

(

Logger *

logger

)

~SETimedStabilization()

SETimedStabilization::~SETimedStabilization ( )

virtual

Member Function Documentation

Clear()

void SETimedStabilization::Clear ( )

overridevirtual

Reimplemented from SEEngineStabilization.

GetConvergenceCriteria() [1/2]

SEScalarTime & SETimedStabilization::GetConvergenceCriteria ( const std::string &  name )

virtual

GetConvergenceCriteria() [2/2]

const SEScalarTime * SETimedStabilization::GetConvergenceCriteria ( const std::string &  name ) const

virtual

GetConvergenceCriterias()

const std::map< std::string, SEScalarTime * > & SETimedStabilization::GetConvergenceCriterias ( ) const

virtual

HasConvergenceCriteria()

bool SETimedStabilization::HasConvergenceCriteria ( const std::string &  name ) const

overridevirtual

Implements SEEngineStabilization.

RemoveConvergenceCriteria()

void SETimedStabilization::RemoveConvergenceCriteria ( const std::string &  name )

overridevirtual

Implements SEEngineStabilization.

SerializeFromFile()

bool SETimedStabilization::SerializeFromFile ( const std::string &  filename )

virtual

Implements SEEngineStabilization.

SerializeFromString()

bool SETimedStabilization::SerializeFromString ( const std::string &  src, eSerializationFormat  m  )

virtual

Implements SEEngineStabilization.

SerializeToFile()

bool SETimedStabilization::SerializeToFile ( const std::string &  filename ) const

virtual

Implements SEEngineStabilization.

SerializeToString()

bool SETimedStabilization::SerializeToString ( std::string &  output, eSerializationFormat  m  ) const

virtual

Implements SEEngineStabilization.

Stabilize() [1/2]

bool SETimedStabilization::Stabilize ( Controller &  engine, const SEScalarTime &  time  )

protectedvirtual

Stabilize() [2/2]

bool SETimedStabilization::Stabilize ( Controller &  engine, const std::string &  criteria  )

overridevirtual

Implements SEEngineStabilization.

StabilizeConditions()

bool SETimedStabilization::StabilizeConditions ( Controller &  engine, const SEConditionManager &  conditions  )

overridevirtual

Implements SEEngineStabilization.

Friends And Related Function Documentation

PBEngine

friend class PBEngine

friend

Member Data Documentation

m_ConvergenceCriteria

std::map<std::string,SEScalarTime*> SETimedStabilization::m_ConvergenceCriteria

protected