SEEngineStabilization Class Reference

#include <SEEngineStabilization.h>

Inherits Loggable.

Inherited by SEDynamicStabilization, and SETimedStabilization.

Classes
class	Controller

Public Member Functions
	SEEngineStabilization (Logger *logger)
virtual	~SEEngineStabilization ()
virtual void	Clear ()
virtual bool	SerializeToString (std::string &output, eSerializationFormat) const =0
virtual bool	SerializeToFile (const std::string &filename) const =0
virtual bool	SerializeFromString (const std::string &src, eSerializationFormat)=0
virtual bool	SerializeFromFile (const std::string &filename)=0
virtual bool	HasConvergenceCriteria (const std::string &criteria) const =0
virtual void	RemoveConvergenceCriteria (const std::string &name)=0
virtual bool	Stabilize (Controller &engine, const std::string &criteria)=0
virtual bool	StabilizeConditions (Controller &engine, const SEConditionManager &conditions)=0
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

Static Public Attributes
static constexpr char const *	Resting = "Resting"
static constexpr char const *	AdvanceUntilStable = "AdvanceUntilStable"

Protected Attributes
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

Constructor & Destructor Documentation

SEEngineStabilization()

SEEngineStabilization::SEEngineStabilization

(

Logger *

logger

)

~SEEngineStabilization()

SEEngineStabilization::~SEEngineStabilization ( )

virtual

Member Function Documentation

CancelStabilization()

void SEEngineStabilization::CancelStabilization ( )

virtual

Clear()

void SEEngineStabilization::Clear ( )

virtual

Reimplemented in SEDynamicStabilization, and SETimedStabilization.

GetStabilizationDuration()

SEScalarTime & SEEngineStabilization::GetStabilizationDuration ( )

virtual

HasConvergenceCriteria()

virtual bool SEEngineStabilization::HasConvergenceCriteria ( const std::string &  criteria ) const

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

HasStabilizationDuration()

bool SEEngineStabilization::HasStabilizationDuration ( )

virtual

IsTrackingStabilization()

bool SEEngineStabilization::IsTrackingStabilization ( )

virtual

LogProgress()

void SEEngineStabilization::LogProgress ( bool  b )

virtual

RemoveConvergenceCriteria()

virtual void SEEngineStabilization::RemoveConvergenceCriteria ( const std::string &  name )

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

SerializeFromFile()

virtual bool SEEngineStabilization::SerializeFromFile ( const std::string &  filename )

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

SerializeFromString()

virtual bool SEEngineStabilization::SerializeFromString ( const std::string &  src, eSerializationFormat    )

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

SerializeToFile()

virtual bool SEEngineStabilization::SerializeToFile ( const std::string &  filename ) const

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

SerializeToString()

virtual bool SEEngineStabilization::SerializeToString ( std::string &  output, eSerializationFormat    ) const

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

Stabilize()

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

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

StabilizeConditions()

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

pure virtual

Implemented in SEDynamicStabilization, and SETimedStabilization.

TrackStabilization()

void SEEngineStabilization::TrackStabilization ( eSwitch  state )

virtual

Member Data Documentation

AdvanceUntilStable

constexpr char const* SEEngineStabilization::AdvanceUntilStable = "AdvanceUntilStable"

staticconstexpr

m_Cancelled

bool SEEngineStabilization::m_Cancelled

protected

m_Conditions

std::vector<const SECondition*> SEEngineStabilization::m_Conditions

protected

m_LogProgress

bool SEEngineStabilization::m_LogProgress

protected

m_ss

std::stringstream SEEngineStabilization::m_ss

protected

m_StabilizationDuration

SEScalarTime* SEEngineStabilization::m_StabilizationDuration

protected

m_TrackingStabilization

eSwitch SEEngineStabilization::m_TrackingStabilization

protected

Resting

constexpr char const* SEEngineStabilization::Resting = "Resting"

staticconstexpr