Default PISM configuration database: uses NetCDF files; can be initialized from a file specified using a command-line option. More...

#include <Config.hh>

Inheritance diagram for pism::DefaultConfig:

Public Types
typedef std::shared_ptr< DefaultConfig >	Ptr

typedef std::shared_ptr< const DefaultConfig >	ConstPtr

Public Types inherited from pism::Config
enum	UseFlag { REMEMBER_THIS_USE = 0 , FORGET_THIS_USE = 1 }
	Flag used by `get_...()` methods. More...

typedef std::shared_ptr< Config >	Ptr

typedef std::shared_ptr< const Config >	ConstPtr

typedef std::map< std::string, std::vector< double > >	Doubles

typedef std::map< std::string, std::string >	Strings

typedef std::map< std::string, bool >	Flags

Public Member Functions
	DefaultConfig (MPI_Comm com, const std::string &variable_name, const std::string &option, units::System::Ptr unit_system)
	Config that respects command-line options and stores data in a NetCDF variable.

	~DefaultConfig ()=default

void	init_with_default (const Logger &log)
	Initialize (use default path if no option was set).

void	init (const Logger &log)
	Initialize (leave empty if no option was set).

Public Member Functions inherited from pism::NetCDFConfig
	NetCDFConfig (MPI_Comm com, const std::string &name, units::System::Ptr unit_system)

	~NetCDFConfig ()

Public Member Functions inherited from pism::Config
	Config (units::System::Ptr unit_system)

virtual	~Config ()

void	import_from (const Config &other)

void	resolve_filenames ()

const std::set< std::string > &	parameters_set_by_user () const

const std::set< std::string > &	parameters_used () const

void	read (MPI_Comm com, const std::string &filename)

void	write (MPI_Comm com, const std::string &filename, bool append=true) const

std::string	filename () const
	Returns the name of the file used to initialize the database.

void	read (const File &file)

void	write (const File &file) const

bool	is_set (const std::string &name) const

bool	is_valid_number (const std::string &name) const

Doubles	all_doubles () const

double	get_number (const std::string &name, UseFlag flag=REMEMBER_THIS_USE) const

double	get_number (const std::string &name, const std::string &units, UseFlag flag=REMEMBER_THIS_USE) const

std::vector< double >	get_numbers (const std::string &name, UseFlag flag=REMEMBER_THIS_USE) const

std::vector< double >	get_numbers (const std::string &name, const std::string &units, UseFlag flag=REMEMBER_THIS_USE) const

void	set_number (const std::string &name, double value, ConfigSettingFlag flag=CONFIG_FORCE)

void	set_numbers (const std::string &name, const std::vector< double > &values, ConfigSettingFlag flag=CONFIG_FORCE)

Strings	all_strings () const

std::string	get_string (const std::string &name, UseFlag flag=REMEMBER_THIS_USE) const

void	set_string (const std::string &name, const std::string &value, ConfigSettingFlag flag=CONFIG_FORCE)

Flags	all_flags () const

std::set< std::string >	keys () const

bool	get_flag (const std::string &name, UseFlag flag=REMEMBER_THIS_USE) const

void	set_flag (const std::string &name, bool value, ConfigSettingFlag flag=CONFIG_FORCE)

std::string	doc (const std::string &parameter) const

std::string	units (const std::string &parameter) const

std::string	type (const std::string &parameter) const

std::string	option (const std::string &parameter) const

std::string	choices (const std::string &parameter) const

std::pair< bool, double >	valid_min (const std::string &parameter) const

std::pair< bool, double >	valid_max (const std::string &parameter) const

Private Member Functions
void	init (const Logger &log, bool use_default_path)

Private Attributes
std::string	m_option

Additional Inherited Members
Protected Member Functions inherited from pism::NetCDFConfig
void	read_impl (const File &file)
	Read flag flags and double parameters from a NetCDF file.

void	write_impl (const File &file) const
	Write a config variable to a file (with all its attributes).

bool	is_set_impl (const std::string &name) const

Doubles	all_doubles_impl () const

double	get_number_impl (const std::string &name) const

std::vector< double >	get_numbers_impl (const std::string &name) const

void	set_number_impl (const std::string &name, double value)

void	set_numbers_impl (const std::string &name, const std::vector< double > &values)

Strings	all_strings_impl () const

std::string	get_string_impl (const std::string &name) const

void	set_string_impl (const std::string &name, const std::string &value)

Flags	all_flags_impl () const

bool	get_flag_impl (const std::string &name) const

void	set_flag_impl (const std::string &name, bool value)
	Set a value of a flag flag.

Protected Attributes inherited from pism::NetCDFConfig
MPI_Comm	m_com

VariableMetadata	m_data

Detailed Description

Default PISM configuration database: uses NetCDF files; can be initialized from a file specified using a command-line option.

Definition at line 72 of file Config.hh.

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

src/util/Config.hh
src/util/Config.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description