SEEnvironmentalConditions Class Reference

#include <SEEnvironmentalConditions.h>

Inherits Loggable.

Public Member Functions

 SEEnvironmentalConditions (Logger *logger)
 
virtual ~SEEnvironmentalConditions ()
 
virtual void Clear ()
 
virtual void Copy (const SEEnvironmentalConditions &, const SESubstanceManager &)
 
bool SerializeToString (std::string &output, eSerializationFormat m) const
 
bool SerializeToFile (const std::string &filename) const
 
bool SerializeFromString (const std::string &src, eSerializationFormat m, const SESubstanceManager &subMgr)
 
bool SerializeFromFile (const std::string &filename, const SESubstanceManager &subMgr)
 
virtual void Merge (const SEEnvironmentalConditions &from, SESubstanceManager &subMgr)
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual eSurroundingType GetSurroundingType () const
 
virtual void SetSurroundingType (eSurroundingType name)
 
virtual bool HasAirDensity () const
 
virtual SEScalarMassPerVolumeGetAirDensity ()
 
virtual double GetAirDensity (const MassPerVolumeUnit &unit) const
 
virtual bool HasAirVelocity () const
 
virtual SEScalarLengthPerTimeGetAirVelocity ()
 
virtual double GetAirVelocity (const LengthPerTimeUnit &unit) const
 
virtual bool HasAmbientTemperature () const
 
virtual SEScalarTemperatureGetAmbientTemperature ()
 
virtual double GetAmbientTemperature (const TemperatureUnit &unit) const
 
virtual bool HasAtmosphericPressure () const
 
virtual SEScalarPressureGetAtmosphericPressure ()
 
virtual double GetAtmosphericPressure (const PressureUnit &unit) const
 
virtual bool HasClothingResistance () const
 
virtual SEScalarHeatResistanceAreaGetClothingResistance ()
 
virtual double GetClothingResistance (const HeatResistanceAreaUnit &unit) const
 
virtual bool HasEmissivity () const
 
virtual SEScalar0To1GetEmissivity ()
 
virtual double GetEmissivity () const
 
virtual bool HasMeanRadiantTemperature () const
 
virtual SEScalarTemperatureGetMeanRadiantTemperature ()
 
virtual double GetMeanRadiantTemperature (const TemperatureUnit &unit) const
 
virtual bool HasMechanicalDeadSpace () const
 
virtual SEScalarVolumeGetMechanicalDeadSpace ()
 
virtual double GetMechanicalDeadSpace (const VolumeUnit &unit) const
 
virtual bool HasRelativeHumidity () const
 
virtual SEScalar0To1GetRelativeHumidity ()
 
virtual double GetRelativeHumidity () const
 
virtual bool HasRespirationAmbientTemperature () const
 
virtual SEScalarTemperatureGetRespirationAmbientTemperature ()
 
virtual double GetRespirationAmbientTemperature (const TemperatureUnit &unit) const
 
bool HasAmbientGas () const
 
bool HasAmbientGas (const SESubstance &substance) const
 
const std::vector< SESubstanceFraction * > & GetAmbientGases ()
 
const std::vector< const SESubstanceFraction * > & GetAmbientGases () const
 
SESubstanceFractionGetAmbientGas (const SESubstance &substance)
 
const SESubstanceFractionGetAmbientGas (const SESubstance &substance) const
 
void RemoveAmbientGas (const SESubstance &substance)
 
void RemoveAmbientGases ()
 
bool HasAmbientAerosol () const
 
bool HasAmbientAerosol (const SESubstance &substance) const
 
const std::vector< SESubstanceConcentration * > & GetAmbientAerosols ()
 
const std::vector< const SESubstanceConcentration * > & GetAmbientAerosols () const
 
SESubstanceConcentrationGetAmbientAerosol (const SESubstance &substance)
 
const SESubstanceConcentrationGetAmbientAerosol (const SESubstance &substance) const
 
void RemoveAmbientAerosol (const SESubstance &substance)
 
void RemoveAmbientAerosols ()
 
- 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) 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 Attributes

eSurroundingType m_SurroundingType
 
SEScalarMassPerVolumem_AirDensity
 
SEScalarLengthPerTimem_AirVelocity
 
SEScalarTemperaturem_AmbientTemperature
 
SEScalarPressurem_AtmosphericPressure
 
SEScalarHeatResistanceAream_ClothingResistance
 
SEScalar0To1m_Emissivity
 
SEScalarTemperaturem_MeanRadiantTemperature
 
SEScalarVolumem_MechanicalDeadSpace
 
SEScalar0To1m_RelativeHumidity
 
SEScalarTemperaturem_RespirationAmbientTemperature
 
std::vector< SESubstanceFraction * > m_AmbientGases
 
std::vector< const SESubstanceFraction * > m_cAmbientGases
 
std::vector< SESubstanceConcentration * > m_AmbientAerosols
 
std::vector< const SESubstanceConcentration * > m_cAmbientAerosols
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class PBEnvironment
 
class SEEnvironment
 
class SEChangeEnvironmentConditions
 
class SEInitialEnvironmentConditions
 

Constructor & Destructor Documentation

◆ SEEnvironmentalConditions()

SEEnvironmentalConditions::SEEnvironmentalConditions ( Logger logger)

◆ ~SEEnvironmentalConditions()

SEEnvironmentalConditions::~SEEnvironmentalConditions ( )
virtual

Member Function Documentation

◆ Clear()

void SEEnvironmentalConditions::Clear ( )
virtual

◆ Copy()

void SEEnvironmentalConditions::Copy ( const SEEnvironmentalConditions src,
const SESubstanceManager subMgr 
)
virtual

◆ GetAirDensity() [1/2]

SEScalarMassPerVolume & SEEnvironmentalConditions::GetAirDensity ( )
virtual

◆ GetAirDensity() [2/2]

double SEEnvironmentalConditions::GetAirDensity ( const MassPerVolumeUnit unit) const
virtual

◆ GetAirVelocity() [1/2]

SEScalarLengthPerTime & SEEnvironmentalConditions::GetAirVelocity ( )
virtual

◆ GetAirVelocity() [2/2]

double SEEnvironmentalConditions::GetAirVelocity ( const LengthPerTimeUnit unit) const
virtual

◆ GetAmbientAerosol() [1/2]

SESubstanceConcentration & SEEnvironmentalConditions::GetAmbientAerosol ( const SESubstance substance)

◆ GetAmbientAerosol() [2/2]

const SESubstanceConcentration * SEEnvironmentalConditions::GetAmbientAerosol ( const SESubstance substance) const

◆ GetAmbientAerosols() [1/2]

const std::vector< SESubstanceConcentration * > & SEEnvironmentalConditions::GetAmbientAerosols ( )

◆ GetAmbientAerosols() [2/2]

const std::vector< const SESubstanceConcentration * > & SEEnvironmentalConditions::GetAmbientAerosols ( ) const

◆ GetAmbientGas() [1/2]

SESubstanceFraction & SEEnvironmentalConditions::GetAmbientGas ( const SESubstance substance)

◆ GetAmbientGas() [2/2]

const SESubstanceFraction * SEEnvironmentalConditions::GetAmbientGas ( const SESubstance substance) const

◆ GetAmbientGases() [1/2]

const std::vector< SESubstanceFraction * > & SEEnvironmentalConditions::GetAmbientGases ( )

◆ GetAmbientGases() [2/2]

const std::vector< const SESubstanceFraction * > & SEEnvironmentalConditions::GetAmbientGases ( ) const

◆ GetAmbientTemperature() [1/2]

SEScalarTemperature & SEEnvironmentalConditions::GetAmbientTemperature ( )
virtual

◆ GetAmbientTemperature() [2/2]

double SEEnvironmentalConditions::GetAmbientTemperature ( const TemperatureUnit unit) const
virtual

◆ GetAtmosphericPressure() [1/2]

SEScalarPressure & SEEnvironmentalConditions::GetAtmosphericPressure ( )
virtual

◆ GetAtmosphericPressure() [2/2]

double SEEnvironmentalConditions::GetAtmosphericPressure ( const PressureUnit unit) const
virtual

◆ GetClothingResistance() [1/2]

SEScalarHeatResistanceArea & SEEnvironmentalConditions::GetClothingResistance ( )
virtual

◆ GetClothingResistance() [2/2]

double SEEnvironmentalConditions::GetClothingResistance ( const HeatResistanceAreaUnit unit) const
virtual

◆ GetEmissivity() [1/2]

SEScalar0To1 & SEEnvironmentalConditions::GetEmissivity ( )
virtual

◆ GetEmissivity() [2/2]

double SEEnvironmentalConditions::GetEmissivity ( ) const
virtual

◆ GetMeanRadiantTemperature() [1/2]

SEScalarTemperature & SEEnvironmentalConditions::GetMeanRadiantTemperature ( )
virtual

◆ GetMeanRadiantTemperature() [2/2]

double SEEnvironmentalConditions::GetMeanRadiantTemperature ( const TemperatureUnit unit) const
virtual

◆ GetMechanicalDeadSpace() [1/2]

SEScalarVolume & SEEnvironmentalConditions::GetMechanicalDeadSpace ( )
virtual

◆ GetMechanicalDeadSpace() [2/2]

double SEEnvironmentalConditions::GetMechanicalDeadSpace ( const VolumeUnit unit) const
virtual

◆ GetRelativeHumidity() [1/2]

SEScalar0To1 & SEEnvironmentalConditions::GetRelativeHumidity ( )
virtual

◆ GetRelativeHumidity() [2/2]

double SEEnvironmentalConditions::GetRelativeHumidity ( ) const
virtual

◆ GetRespirationAmbientTemperature() [1/2]

SEScalarTemperature & SEEnvironmentalConditions::GetRespirationAmbientTemperature ( )
virtual

◆ GetRespirationAmbientTemperature() [2/2]

double SEEnvironmentalConditions::GetRespirationAmbientTemperature ( const TemperatureUnit unit) const
virtual

◆ GetScalar()

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

◆ GetSurroundingType()

eSurroundingType SEEnvironmentalConditions::GetSurroundingType ( ) const
virtual

◆ HasAirDensity()

bool SEEnvironmentalConditions::HasAirDensity ( ) const
virtual

◆ HasAirVelocity()

bool SEEnvironmentalConditions::HasAirVelocity ( ) const
virtual

◆ HasAmbientAerosol() [1/2]

bool SEEnvironmentalConditions::HasAmbientAerosol ( ) const

◆ HasAmbientAerosol() [2/2]

bool SEEnvironmentalConditions::HasAmbientAerosol ( const SESubstance substance) const

◆ HasAmbientGas() [1/2]

bool SEEnvironmentalConditions::HasAmbientGas ( ) const

◆ HasAmbientGas() [2/2]

bool SEEnvironmentalConditions::HasAmbientGas ( const SESubstance substance) const

◆ HasAmbientTemperature()

bool SEEnvironmentalConditions::HasAmbientTemperature ( ) const
virtual

◆ HasAtmosphericPressure()

bool SEEnvironmentalConditions::HasAtmosphericPressure ( ) const
virtual

◆ HasClothingResistance()

bool SEEnvironmentalConditions::HasClothingResistance ( ) const
virtual

◆ HasEmissivity()

bool SEEnvironmentalConditions::HasEmissivity ( ) const
virtual

◆ HasMeanRadiantTemperature()

bool SEEnvironmentalConditions::HasMeanRadiantTemperature ( ) const
virtual

◆ HasMechanicalDeadSpace()

bool SEEnvironmentalConditions::HasMechanicalDeadSpace ( ) const
virtual

◆ HasRelativeHumidity()

bool SEEnvironmentalConditions::HasRelativeHumidity ( ) const
virtual

◆ HasRespirationAmbientTemperature()

bool SEEnvironmentalConditions::HasRespirationAmbientTemperature ( ) const
virtual

◆ Merge()

void SEEnvironmentalConditions::Merge ( const SEEnvironmentalConditions from,
SESubstanceManager subMgr 
)
virtual

◆ RemoveAmbientAerosol()

void SEEnvironmentalConditions::RemoveAmbientAerosol ( const SESubstance substance)

◆ RemoveAmbientAerosols()

void SEEnvironmentalConditions::RemoveAmbientAerosols ( )

◆ RemoveAmbientGas()

void SEEnvironmentalConditions::RemoveAmbientGas ( const SESubstance substance)

◆ RemoveAmbientGases()

void SEEnvironmentalConditions::RemoveAmbientGases ( )

◆ SerializeFromFile()

bool SEEnvironmentalConditions::SerializeFromFile ( const std::string &  filename,
const SESubstanceManager subMgr 
)

◆ SerializeFromString()

bool SEEnvironmentalConditions::SerializeFromString ( const std::string &  src,
eSerializationFormat  m,
const SESubstanceManager subMgr 
)

◆ SerializeToFile()

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

◆ SerializeToString()

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

◆ SetSurroundingType()

void SEEnvironmentalConditions::SetSurroundingType ( eSurroundingType  name)
virtual

Friends And Related Function Documentation

◆ PBEnvironment

friend class PBEnvironment
friend

◆ SEChangeEnvironmentConditions

friend class SEChangeEnvironmentConditions
friend

◆ SEEnvironment

friend class SEEnvironment
friend

◆ SEInitialEnvironmentConditions

friend class SEInitialEnvironmentConditions
friend

Member Data Documentation

◆ m_AirDensity

SEScalarMassPerVolume* SEEnvironmentalConditions::m_AirDensity
protected

◆ m_AirVelocity

SEScalarLengthPerTime* SEEnvironmentalConditions::m_AirVelocity
protected

◆ m_AmbientAerosols

std::vector<SESubstanceConcentration*> SEEnvironmentalConditions::m_AmbientAerosols
protected

◆ m_AmbientGases

std::vector<SESubstanceFraction*> SEEnvironmentalConditions::m_AmbientGases
protected

◆ m_AmbientTemperature

SEScalarTemperature* SEEnvironmentalConditions::m_AmbientTemperature
protected

◆ m_AtmosphericPressure

SEScalarPressure* SEEnvironmentalConditions::m_AtmosphericPressure
protected

◆ m_cAmbientAerosols

std::vector<const SESubstanceConcentration*> SEEnvironmentalConditions::m_cAmbientAerosols
protected

◆ m_cAmbientGases

std::vector<const SESubstanceFraction*> SEEnvironmentalConditions::m_cAmbientGases
protected

◆ m_ClothingResistance

SEScalarHeatResistanceArea* SEEnvironmentalConditions::m_ClothingResistance
protected

◆ m_Emissivity

SEScalar0To1* SEEnvironmentalConditions::m_Emissivity
protected

◆ m_MeanRadiantTemperature

SEScalarTemperature* SEEnvironmentalConditions::m_MeanRadiantTemperature
protected

◆ m_MechanicalDeadSpace

SEScalarVolume* SEEnvironmentalConditions::m_MechanicalDeadSpace
protected

◆ m_RelativeHumidity

SEScalar0To1* SEEnvironmentalConditions::m_RelativeHumidity
protected

◆ m_RespirationAmbientTemperature

SEScalarTemperature* SEEnvironmentalConditions::m_RespirationAmbientTemperature
protected

◆ m_SurroundingType

eSurroundingType SEEnvironmentalConditions::m_SurroundingType
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.