SEThermalApplication Class Reference

#include <SEThermalApplication.h>

Inherits SEEnvironmentAction.

Public Member Functions

 SEThermalApplication (Logger *logger=nullptr)
 
virtual ~SEThermalApplication ()
 
virtual void Clear ()
 
virtual void Copy (const SEThermalApplication &src, bool=false)
 
virtual bool IsValid () const
 
virtual bool IsActive () const
 
virtual void Deactivate ()
 
virtual bool HasActiveHeating () const
 
virtual SEActiveConditioningGetActiveHeating ()
 
virtual const SEActiveConditioningGetActiveHeating () const
 
virtual void RemoveActiveHeating ()
 
virtual bool HasActiveCooling () const
 
virtual SEActiveConditioningGetActiveCooling ()
 
virtual const SEActiveConditioningGetActiveCooling () const
 
virtual void RemoveActiveCooling ()
 
virtual bool HasAppliedTemperature () const
 
virtual SEAppliedTemperatureGetAppliedTemperature ()
 
virtual const SEAppliedTemperatureGetAppliedTemperature () const
 
virtual void RemoveAppliedTemperature ()
 
virtual void ToString (std::ostream &str) const
 
virtual const SEScalarGetScalar (const std::string &name)
 
- Public Member Functions inherited from SEEnvironmentAction
 SEEnvironmentAction (Logger *logger)
 
virtual ~SEEnvironmentAction ()
 
- Public Member Functions inherited from SEAction
 SEAction (Logger *logger)
 
virtual ~SEAction ()
 
 SEAction (const SEAction &)=delete
 
SEActionoperator= (const SEAction &)=delete
 
virtual void Activate ()
 
virtual std::string GetComment () const
 
virtual void SetComment (const std::string &comment)
 
virtual bool HasComment () const
 
virtual void InvalidateComment ()
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
virtual void SetLogger (Logger &logger)
 
virtual void Debug (std::string const &msg, std::string const &origin=empty) const
 
virtual void Debug (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Debug (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Info (std::string const &msg, std::string const &origin=empty) const
 
virtual void Info (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (const std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::string const &msg, std::string const &origin=empty) const
 
virtual void Warning (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Error (std::string const &msg, std::string const &origin=empty) const
 
virtual void Error (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Error (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::string const &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::ostream &msg, std::string const &origin=empty) const
 

Protected Attributes

bool m_ClearContents
 
SEActiveConditioningm_ActiveHeating
 
SEActiveConditioningm_ActiveCooling
 
SEAppliedTemperaturem_AppliedTemperature
 
- Protected Attributes inherited from SEAction
bool m_Active = true
 
std::string m_Comment
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class PBEnvironmentAction
 

Additional Inherited Members

- Static Public Member Functions inherited from SEAction
static SEActionCopy (const SEAction &, const SESubstanceManager &)
 
- Static Public Attributes inherited from Loggable
static const std::string empty
 

Constructor & Destructor Documentation

◆ SEThermalApplication()

SEThermalApplication::SEThermalApplication ( Logger logger = nullptr)

◆ ~SEThermalApplication()

SEThermalApplication::~SEThermalApplication ( )
virtual

Member Function Documentation

◆ Clear()

void SEThermalApplication::Clear ( )
virtual

Reimplemented from SEEnvironmentAction.

◆ Copy()

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

◆ Deactivate()

void SEThermalApplication::Deactivate ( )
virtual

Reimplemented from SEAction.

◆ 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

◆ GetScalar()

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

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
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 SEThermalApplication::IsValid ( ) const
virtual

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

◆ ToString()

void SEThermalApplication::ToString ( std::ostream &  str) const
virtual

Implements SEEnvironmentAction.

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

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.