biogears::SEEnvironmentalConditions Class Reference

#include <SEEnvironmentalConditions.h>

Inheritance diagram for biogears::SEEnvironmentalConditions:

Public Member Functions

 SEEnvironmentalConditions (SESubstanceManager &substances)
 
virtual ~SEEnvironmentalConditions ()
 
virtual void Clear ()
 
virtual bool Load (const CDM::EnvironmentalConditionsData &in)
 
virtual bool Load (const char *environmentFile)
 
virtual bool Load (const std::string &environmentFile)
 
virtual CDM::EnvironmentalConditionsDataUnload () const
 
virtual const SEScalarGetScalar (const char *name)
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual std::string GetName () const
 
virtual const char * GetName_cStr () const
 
virtual void SetName (const char *name)
 
virtual void SetName (const std::string &name)
 
virtual bool HasName () const
 
virtual void InvalidateName ()
 
virtual CDM::enumSurroundingType::value GetSurroundingType () const
 
virtual void SetSurroundingType (CDM::enumSurroundingType::value name)
 
virtual bool HasSurroundingType () const
 
virtual void InvalidateSurroundingType ()
 
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 SEScalarFractionGetEmissivity ()
 
virtual double GetEmissivity () const
 
virtual bool HasMeanRadiantTemperature () const
 
virtual SEScalarTemperatureGetMeanRadiantTemperature ()
 
virtual double GetMeanRadiantTemperature (const TemperatureUnit &unit) const
 
virtual bool HasRelativeHumidity () const
 
virtual SEScalarFractionGetRelativeHumidity ()
 
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 (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 (SESubstance &substance)
 
const SESubstanceConcentrationGetAmbientAerosol (const SESubstance &substance) const
 
void RemoveAmbientAerosol (const SESubstance &substance)
 
void RemoveAmbientAerosols ()
 
- Public Member Functions inherited from biogears::Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 

Protected Member Functions

virtual void Unload (CDM::EnvironmentalConditionsData &data) const
 
virtual void Merge (const SEEnvironmentalConditions &from)
 
- Protected Member Functions inherited from biogears::Loggable
virtual void Debug (const char *msg, const char *origin="") const
 
virtual void Debug (const std::string &msg, const std::string &origin=empty) const
 
virtual void Debug (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Info (const char *msg, const char *origin="") const
 
virtual void Info (const std::string &msg, const std::string &origin=empty) const
 
virtual void Info (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Warning (const char *msg, const char *origin="") const
 
virtual void Warning (const std::string &msg, const std::string &origin=empty) const
 
virtual void Warning (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Error (const char *msg, const char *origin="") const
 
virtual void Error (const std::string msg, const std::string origin=empty) const
 
virtual void Error (std::ostream &msg, const std::string &origin=empty) const
 
virtual void Fatal (const char *msg, const char *origin="") const
 
virtual void Fatal (const std::string &msg, const std::string &origin=empty) const
 
virtual void Fatal (std::ostream &msg, const std::string &origin=empty) const
 

Protected Attributes

friend SEEnvironment
 
friend SEEnvironmentChange
 
friend SEInitialEnvironment
 
CDM::enumSurroundingType::value m_SurroundingType
 
std::string m_Name
 
SEScalarMassPerVolumem_AirDensity
 
SEScalarLengthPerTimem_AirVelocity
 
SEScalarTemperaturem_AmbientTemperature
 
SEScalarPressurem_AtmosphericPressure
 
SEScalarHeatResistanceAream_ClothingResistance
 
SEScalarFractionm_Emissivity
 
SEScalarTemperaturem_MeanRadiantTemperature
 
SEScalarFractionm_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
 
SESubstanceManagerm_Substances
 
- Protected Attributes inherited from biogears::Loggable
Loggerm_Logger
 

Additional Inherited Members

- Static Public Attributes inherited from biogears::Loggable
static const std::string empty
 
static const char * empty_cStr
 

Constructor & Destructor Documentation

biogears::SEEnvironmentalConditions::SEEnvironmentalConditions ( SESubstanceManager substances)
biogears::SEEnvironmentalConditions::~SEEnvironmentalConditions ( )
virtual

Member Function Documentation

void biogears::SEEnvironmentalConditions::Clear ( )
virtual
SEScalarMassPerVolume & biogears::SEEnvironmentalConditions::GetAirDensity ( )
virtual
double biogears::SEEnvironmentalConditions::GetAirDensity ( const MassPerVolumeUnit unit) const
virtual
SEScalarLengthPerTime & biogears::SEEnvironmentalConditions::GetAirVelocity ( )
virtual
double biogears::SEEnvironmentalConditions::GetAirVelocity ( const LengthPerTimeUnit unit) const
virtual
SESubstanceConcentration & biogears::SEEnvironmentalConditions::GetAmbientAerosol ( SESubstance substance)
const SESubstanceConcentration * biogears::SEEnvironmentalConditions::GetAmbientAerosol ( const SESubstance substance) const
const std::vector< SESubstanceConcentration * > & biogears::SEEnvironmentalConditions::GetAmbientAerosols ( )
const std::vector< const SESubstanceConcentration * > & biogears::SEEnvironmentalConditions::GetAmbientAerosols ( ) const
SESubstanceFraction & biogears::SEEnvironmentalConditions::GetAmbientGas ( SESubstance substance)
const SESubstanceFraction * biogears::SEEnvironmentalConditions::GetAmbientGas ( const SESubstance substance) const
const std::vector< SESubstanceFraction * > & biogears::SEEnvironmentalConditions::GetAmbientGases ( )
const std::vector< const SESubstanceFraction * > & biogears::SEEnvironmentalConditions::GetAmbientGases ( ) const
SEScalarTemperature & biogears::SEEnvironmentalConditions::GetAmbientTemperature ( )
virtual
double biogears::SEEnvironmentalConditions::GetAmbientTemperature ( const TemperatureUnit unit) const
virtual
SEScalarPressure & biogears::SEEnvironmentalConditions::GetAtmosphericPressure ( )
virtual
double biogears::SEEnvironmentalConditions::GetAtmosphericPressure ( const PressureUnit unit) const
virtual
SEScalarHeatResistanceArea & biogears::SEEnvironmentalConditions::GetClothingResistance ( )
virtual
double biogears::SEEnvironmentalConditions::GetClothingResistance ( const HeatResistanceAreaUnit unit) const
virtual
SEScalarFraction & biogears::SEEnvironmentalConditions::GetEmissivity ( )
virtual
double biogears::SEEnvironmentalConditions::GetEmissivity ( ) const
virtual
SEScalarTemperature & biogears::SEEnvironmentalConditions::GetMeanRadiantTemperature ( )
virtual
double biogears::SEEnvironmentalConditions::GetMeanRadiantTemperature ( const TemperatureUnit unit) const
virtual
std::string biogears::SEEnvironmentalConditions::GetName ( ) const
virtual
const char * biogears::SEEnvironmentalConditions::GetName_cStr ( ) const
virtual
SEScalarFraction & biogears::SEEnvironmentalConditions::GetRelativeHumidity ( )
virtual
double biogears::SEEnvironmentalConditions::GetRelativeHumidity ( ) const
virtual
SEScalarTemperature & biogears::SEEnvironmentalConditions::GetRespirationAmbientTemperature ( )
virtual
double biogears::SEEnvironmentalConditions::GetRespirationAmbientTemperature ( const TemperatureUnit unit) const
virtual
const SEScalar * biogears::SEEnvironmentalConditions::GetScalar ( const char *  name)
virtual
const SEScalar * biogears::SEEnvironmentalConditions::GetScalar ( const std::string &  name)
virtual
CDM::enumSurroundingType::value biogears::SEEnvironmentalConditions::GetSurroundingType ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasAirDensity ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasAirVelocity ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasAmbientAerosol ( ) const
bool biogears::SEEnvironmentalConditions::HasAmbientAerosol ( const SESubstance substance) const
bool biogears::SEEnvironmentalConditions::HasAmbientGas ( ) const
bool biogears::SEEnvironmentalConditions::HasAmbientGas ( const SESubstance substance) const
bool biogears::SEEnvironmentalConditions::HasAmbientTemperature ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasAtmosphericPressure ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasClothingResistance ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasEmissivity ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasMeanRadiantTemperature ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasName ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasRelativeHumidity ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasRespirationAmbientTemperature ( ) const
virtual
bool biogears::SEEnvironmentalConditions::HasSurroundingType ( ) const
virtual
void biogears::SEEnvironmentalConditions::InvalidateName ( )
virtual
void biogears::SEEnvironmentalConditions::InvalidateSurroundingType ( )
virtual
bool biogears::SEEnvironmentalConditions::Load ( const CDM::EnvironmentalConditionsData in)
virtual
bool biogears::SEEnvironmentalConditions::Load ( const char *  environmentFile)
virtual
bool biogears::SEEnvironmentalConditions::Load ( const std::string &  environmentFile)
virtual
void biogears::SEEnvironmentalConditions::Merge ( const SEEnvironmentalConditions from)
protectedvirtual
void biogears::SEEnvironmentalConditions::RemoveAmbientAerosol ( const SESubstance substance)
void biogears::SEEnvironmentalConditions::RemoveAmbientAerosols ( )
void biogears::SEEnvironmentalConditions::RemoveAmbientGas ( const SESubstance substance)
void biogears::SEEnvironmentalConditions::RemoveAmbientGases ( )
void biogears::SEEnvironmentalConditions::SetName ( const char *  name)
virtual
void biogears::SEEnvironmentalConditions::SetName ( const std::string &  name)
virtual
void biogears::SEEnvironmentalConditions::SetSurroundingType ( CDM::enumSurroundingType::value  name)
virtual
CDM::EnvironmentalConditionsData * biogears::SEEnvironmentalConditions::Unload ( ) const
virtual
void biogears::SEEnvironmentalConditions::Unload ( CDM::EnvironmentalConditionsData data) const
protectedvirtual

Member Data Documentation

SEScalarMassPerVolume* biogears::SEEnvironmentalConditions::m_AirDensity
protected
SEScalarLengthPerTime* biogears::SEEnvironmentalConditions::m_AirVelocity
protected
std::vector<SESubstanceConcentration*> biogears::SEEnvironmentalConditions::m_AmbientAerosols
protected
std::vector<SESubstanceFraction*> biogears::SEEnvironmentalConditions::m_AmbientGases
protected
SEScalarTemperature* biogears::SEEnvironmentalConditions::m_AmbientTemperature
protected
SEScalarPressure* biogears::SEEnvironmentalConditions::m_AtmosphericPressure
protected
std::vector<const SESubstanceConcentration*> biogears::SEEnvironmentalConditions::m_cAmbientAerosols
protected
std::vector<const SESubstanceFraction*> biogears::SEEnvironmentalConditions::m_cAmbientGases
protected
SEScalarHeatResistanceArea* biogears::SEEnvironmentalConditions::m_ClothingResistance
protected
SEScalarFraction* biogears::SEEnvironmentalConditions::m_Emissivity
protected
SEScalarTemperature* biogears::SEEnvironmentalConditions::m_MeanRadiantTemperature
protected
std::string biogears::SEEnvironmentalConditions::m_Name
protected
SEScalarFraction* biogears::SEEnvironmentalConditions::m_RelativeHumidity
protected
SEScalarTemperature* biogears::SEEnvironmentalConditions::m_RespirationAmbientTemperature
protected
SESubstanceManager& biogears::SEEnvironmentalConditions::m_Substances
protected
CDM::enumSurroundingType::value biogears::SEEnvironmentalConditions::m_SurroundingType
protected
friend biogears::SEEnvironmentalConditions::SEEnvironment
protected
friend biogears::SEEnvironmentalConditions::SEEnvironmentChange
protected
friend biogears::SEEnvironmentalConditions::SEInitialEnvironment
protected