openfluid::base::EnvironmentProperties Class Reference

#include <base/EnvProperties.hpp>

Public Member Functions
	EnvironmentProperties ()
virtual	~EnvironmentProperties ()
bool	setValue (std::string Key, const bool Value)
bool	setValue (std::string Key, const std::string &Value)
bool	getValue (std::string Key, bool &Value) const
bool	getValue (std::string Key, std::string &Value) const

Detailed Description

Class containing execution environment information for funtions

Constructor & Destructor Documentation

openfluid::base::EnvironmentProperties::EnvironmentProperties

(

)

Constructor

virtual openfluid::base::EnvironmentProperties::~EnvironmentProperties ( )

virtual

Destructor

Member Function Documentation

bool openfluid::base::EnvironmentProperties::getValue	(	std::string	Key,
		bool &	Value
	)		const

Gets the boolean value assigned to the key

Returns

true if the value exists as a boolean

bool openfluid::base::EnvironmentProperties::getValue	(	std::string	Key,
		std::string &	Value
	)		const

Gets the string value assigned to the key

Returns

true if the value exists as a string

bool openfluid::base::EnvironmentProperties::setValue	(	std::string	Key,
		const bool	Value
	)

Assigns a boolean value to the corresponding key

Returns

true if the assignment is correct

bool openfluid::base::EnvironmentProperties::setValue	(	std::string	Key,
		const std::string &	Value
	)

Assigns a string value to the corresponding key

Returns

true if the assignment is correct

---

The documentation for this class was generated from the following file:

• base/EnvProperties.hpp