What’s New in the Pulse Physiology Engine 4.4.0
×

#include <SEThermalApplication.h>

Inherits SEEnvironmentAction.

Public Member Functions

 SEThermalApplication (Logger *logger=nullptr)
 
virtual ~SEThermalApplication ()
 
std::string GetName () const override
 
void Clear () override
 
virtual void Copy (const SEThermalApplication &src, bool=false)
 
bool IsValid () const override
 
bool IsActive () const override
 
void Deactivate () override
 
virtual bool HasActiveHeating () const
 
virtual SEActiveConditioning & GetActiveHeating ()
 
virtual const SEActiveConditioning * GetActiveHeating () const
 
virtual void RemoveActiveHeating ()
 
virtual bool HasActiveCooling () const
 
virtual SEActiveConditioning & GetActiveCooling ()
 
virtual const SEActiveConditioning * GetActiveCooling () const
 
virtual void RemoveActiveCooling ()
 
virtual bool HasAppliedTemperature () const
 
virtual SEAppliedTemperature & GetAppliedTemperature ()
 
virtual const SEAppliedTemperature * GetAppliedTemperature () const
 
virtual void RemoveAppliedTemperature ()
 
const SEScalar * GetScalar (const std::string &name) override
 
- Public Member Functions inherited from SEEnvironmentAction
 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 * Name = "Thermal Application"
 
- Static Public Attributes inherited from SEEnvironmentAction
static constexpr char const * ActionType = "Environmental"
 
- Static Public Attributes inherited from SEAction
static constexpr char const * ActionType = "Action"
 

Protected Attributes

bool m_ClearContents
 
SEActiveConditioning * m_ActiveHeating
 
SEActiveConditioning * m_ActiveCooling
 
SEAppliedTemperature * m_AppliedTemperature
 
- 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 SEAction * SerializeFromString (const std::string, eSerializationFormat fmt, const SESubstanceManager &)
 
static std::string PrettyPrint (const std::string &str)
 

Constructor & Destructor Documentation

◆ SEThermalApplication()

SEThermalApplication::SEThermalApplication ( Logger *  logger = nullptr)

◆ ~SEThermalApplication()

SEThermalApplication::~SEThermalApplication ( )
virtual

Member Function Documentation

◆ Clear()

void SEThermalApplication::Clear ( )
overridevirtual

Reimplemented from SEEnvironmentAction.

◆ Copy()

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

◆ Deactivate()

void SEThermalApplication::Deactivate ( )
overridevirtual

Reimplemented from SEEnvironmentAction.

◆ GetActiveCooling() [1/2]

SEActiveConditioning & SEThermalApplication::GetActiveCooling ( )
virtual

◆ GetActiveCooling() [2/2]

const SEActiveConditioning * SEThermalApplication::GetActiveCooling ( ) const
virtual

◆ GetActiveHeating() [1/2]

SEActiveConditioning & SEThermalApplication::GetActiveHeating ( )
virtual

◆ GetActiveHeating() [2/2]

const SEActiveConditioning * SEThermalApplication::GetActiveHeating ( ) const
virtual

◆ GetAppliedTemperature() [1/2]

SEAppliedTemperature & SEThermalApplication::GetAppliedTemperature ( )
virtual

◆ GetAppliedTemperature() [2/2]

const SEAppliedTemperature * SEThermalApplication::GetAppliedTemperature ( ) const
virtual

◆ GetName()

std::string SEThermalApplication::GetName ( ) const
inlineoverridevirtual

Implements SEAction.

◆ GetScalar()

const SEScalar * SEThermalApplication::GetScalar ( const std::string &  name)
overridevirtual

Implements SEAction.

◆ HasActiveCooling()

bool SEThermalApplication::HasActiveCooling ( ) const
virtual

◆ HasActiveHeating()

bool SEThermalApplication::HasActiveHeating ( ) const
virtual

◆ HasAppliedTemperature()

bool SEThermalApplication::HasAppliedTemperature ( ) const
virtual

◆ IsActive()

bool SEThermalApplication::IsActive ( ) const
overridevirtual

Reimplemented from SEEnvironmentAction.

◆ IsValid()

bool SEThermalApplication::IsValid ( ) const
overridevirtual

Test if the action has all data it needs

Reimplemented from SEEnvironmentAction.

◆ RemoveActiveCooling()

void SEThermalApplication::RemoveActiveCooling ( )
virtual

◆ RemoveActiveHeating()

void SEThermalApplication::RemoveActiveHeating ( )
virtual

◆ RemoveAppliedTemperature()

void SEThermalApplication::RemoveAppliedTemperature ( )
virtual

Friends And Related Function Documentation

◆ PBEnvironmentAction

friend class PBEnvironmentAction
friend

Member Data Documentation

◆ m_ActiveCooling

SEActiveConditioning* SEThermalApplication::m_ActiveCooling
protected

◆ m_ActiveHeating

SEActiveConditioning* SEThermalApplication::m_ActiveHeating
protected

◆ m_AppliedTemperature

SEAppliedTemperature* SEThermalApplication::m_AppliedTemperature
protected

◆ m_ClearContents

bool SEThermalApplication::m_ClearContents
protected

◆ Name

constexpr char const* SEThermalApplication::Name = "Thermal Application"
staticconstexpr

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.