CoolProp  6.6.1dev
An open-source fluid property and humid air property database
Classes | Namespaces | Macros | Enumerations | Functions
Configuration.h File Reference
#include "Exceptions.h"
#include "CoolPropTools.h"
#include "rapidjson_include.h"

Go to the source code of this file.

Classes

class  CoolProp::ConfigurationItem
 
class  CoolProp::Configuration
 

Namespaces

 CoolProp
 Code for all the binary pairs in the mixture.
 

Macros

#define CONFIGURATION_KEYS_ENUM
 
#define X(Enum, String, Default, Desc)   Enum,
 
#define X(Enum, String, Default, Desc)   add_item(ConfigurationItem(Enum, Default));
 

Enumerations

enum  configuration_keys { CONFIGURATION_KEYS_ENUM }
 
enum  ConfigurationDataTypes {
  CONFIGURATION_NOT_DEFINED_TYPE = 0 , CONFIGURATION_BOOL_TYPE , CONFIGURATION_DOUBLE_TYPE , CONFIGURATION_INTEGER_TYPE ,
  CONFIGURATION_STRING_TYPE , CONFIGURATION_ENDOFLIST_TYPE
}
 

Functions

std::string CoolProp::config_key_to_string (configuration_keys keys)
 Convert the configuration key to a string in a 1-1 representation. More...
 
configuration_keys CoolProp::config_string_to_key (const std::string &s)
 Go from string to enum key. More...
 
std::string CoolProp::config_key_description (configuration_keys keys)
 Return a string description of the configuration key. More...
 
std::string CoolProp::config_key_description (const std::string &key)
 Return a string description of the configuration key (with the key passed as a string) More...
 
bool CoolProp::get_config_bool (configuration_keys key)
 Return the value of a boolean key from the configuration. More...
 
int CoolProp::get_config_int (configuration_keys key)
 Return the value of an integer key from the configuration. More...
 
double CoolProp::get_config_double (configuration_keys key)
 Return the value of a double configuration key. More...
 
std::string CoolProp::get_config_string (configuration_keys key)
 Return the value of a string configuration key. More...
 
void CoolProp::get_config_as_json (rapidjson::Document &doc)
 
std::string CoolProp::get_config_as_json_string ()
 Get all the values in the configuration as a json-formatted string. More...
 
void CoolProp::set_config_bool (configuration_keys key, bool val)
 Set the value of a boolean configuration value. More...
 
void CoolProp::set_config_int (configuration_keys key, int val)
 Set the value of an integer configuration value. More...
 
void CoolProp::set_config_double (configuration_keys key, double val)
 Set the value of a double configuration value. More...
 
void CoolProp::set_config_string (configuration_keys key, const std::string &val)
 Set the value of a string configuration value. More...
 
void CoolProp::set_config_json (rapidjson::Document &doc)
 Set values in the configuration based on a json file. More...
 
void CoolProp::set_config_as_json_string (const std::string &s)
 Set the entire configuration based on a json-formatted string. More...
 

Macro Definition Documentation

◆ CONFIGURATION_KEYS_ENUM

#define CONFIGURATION_KEYS_ENUM

Definition at line 21 of file Configuration.h.

◆ X [1/2]

#define X (   Enum,
  String,
  Default,
  Desc 
)    Enum,

Definition at line 81 of file Configuration.h.

◆ X [2/2]

#define X (   Enum,
  String,
  Default,
  Desc 
)    add_item(ConfigurationItem(Enum, Default));

Definition at line 81 of file Configuration.h.

Enumeration Type Documentation

◆ configuration_keys

Enumerator
CONFIGURATION_KEYS_ENUM 

Definition at line 79 of file Configuration.h.

◆ ConfigurationDataTypes

Enumerator
CONFIGURATION_NOT_DEFINED_TYPE 
CONFIGURATION_BOOL_TYPE 
CONFIGURATION_DOUBLE_TYPE 
CONFIGURATION_INTEGER_TYPE 
CONFIGURATION_STRING_TYPE 
CONFIGURATION_ENDOFLIST_TYPE 

Definition at line 87 of file Configuration.h.