falaise::config Namespace Reference

Namespaces
	type_check_visitor
	Functions for visiting a property item and checking its type is valid.

Classes
class	absorbed_dose_t
	quantity for values with dimension tag absorbed_dose ([L2][T-2]) More...
class	acceleration_t
	quantity for values with dimension tag acceleration ([L][T-2]) More...
class	activity_t
	quantity for values with dimension tag activity ([T-1]) More...
class	amount_t
	quantity for values with dimension tag amount ([N]) More...
class	angle_t
	quantity for values with dimension tag angle ([1]) More...
class	angular_frequency_t
	quantity for values with dimension tag angular_frequency ([T-1]) More...
class	capacitance_t
	quantity for values with dimension tag capacitance ([M-1][L-2][T4][I2]) More...
class	conductance_t
	quantity for values with dimension tag conductance ([M-1][L-2][T3][I2]) More...
class	conductivity_t
	quantity for values with dimension tag conductivity ([M-2][L-2][T3][I2]) More...
class	cross_section_t
	quantity for values with dimension tag cross_section ([L2]) More...
class	data_storage_t
	quantity for values with dimension tag data_storage ([1]) More...
class	data_transfer_rate_t
	quantity for values with dimension tag data_transfer_rate ([T-1]) More...
class	density_t
	quantity for values with dimension tag density ([M][L-3]) More...
class	electric_charge_t
	quantity for values with dimension tag electric_charge ([T][I]) More...
class	electric_current_t
	quantity for values with dimension tag electric_current ([I]) More...
class	electric_displacement_field_t
	quantity for values with dimension tag electric_displacement_field ([L-2][T][I]) More...
class	electric_field_t
	quantity for values with dimension tag electric_field ([M][L][T-3][I-1]) More...
class	electric_flux_t
	quantity for values with dimension tag electric_flux ([M][L3][T-3][I-1]) More...
class	electric_potential_t
	quantity for values with dimension tag electric_potential ([M][L2][T-3][I-1]) More...
class	electric_resistance_t
	quantity for values with dimension tag electric_resistance ([M][L2][T-3][I-2]) More...
class	electric_signal_integral_t
	quantity for values with dimension tag electric_signal_integral ([M][L2][T-2][I-1]) More...
class	energy_t
	quantity for values with dimension tag energy ([M][L2][T-2]) More...
class	equivalent_dose_t
	quantity for values with dimension tag equivalent_dose ([L2][T-2]) More...
class	existing_key_error
	Exception thrown when trying to put to a key already in the property_set. More...
class	force_t
	quantity for values with dimension tag force ([M][L][T-2]) More...
class	fraction_t
	quantity for values with dimension tag fraction ([1]) More...
class	frequency_t
	quantity for values with dimension tag frequency ([T-1]) More...
class	illuminance_t
	quantity for values with dimension tag illuminance () More...
class	inductance_t
	quantity for values with dimension tag inductance ([M][L2][T-2][I-2]) More...
class	invalid_path_error
	Exception for paths that cannot be resolved by datatools::utils. More...
class	length_t
	quantity for values with dimension tag length ([L]) More...
class	level_t
	quantity for values with dimension tag level ([1]) More...
class	luminance_t
	quantity for values with dimension tag luminance ([L-2][J]) More...
class	luminous_energy_density_t
	quantity for values with dimension tag luminous_energy_density () More...
class	luminous_energy_t
	quantity for values with dimension tag luminous_energy () More...
class	luminous_exposure_t
	quantity for values with dimension tag luminous_exposure () More...
class	luminous_flux_t
	quantity for values with dimension tag luminous_flux () More...
class	luminous_intensity_t
	quantity for values with dimension tag luminous_intensity ([J]) More...
class	magnetic_field_strength_t
	quantity for values with dimension tag magnetic_field_strength ([L-1][I]) More...
class	magnetic_flux_density_t
	quantity for values with dimension tag magnetic_flux_density ([M][T-2][I-1]) More...
class	magnetic_flux_t
	quantity for values with dimension tag magnetic_flux ([M][L2][T-2][I-1]) More...
class	mass_activity_t
	quantity for values with dimension tag mass_activity ([M-1][T-1]) More...
class	mass_t
	quantity for values with dimension tag mass ([M]) More...
class	missing_key_error
	Exception thrown when requesting a key that is not in the property_set. More...
class	path
	Class representing a filesystem path as held by a property_set. More...
class	permeability_t
	quantity for values with dimension tag permeability ([M][L][T-2][I-2]) More...
class	permittivity_t
	quantity for values with dimension tag permittivity ([M-1][L-3][T4][I2]) More...
class	power_t
	quantity for values with dimension tag power ([M][L2][T-3]) More...
class	pressure_t
	quantity for values with dimension tag pressure ([M][L-1][T-2]) More...
class	procedure_defined_t
	quantity for values with dimension tag procedure_defined ([?]) More...
class	property_set
	Class holding a set of key-value properties. More...
class	quantity
	Class representing a value and physical unit. More...
class	quantity_t
	Template class for a physical value with a strict dimension. More...
class	resistivity_t
	quantity for values with dimension tag resistivity ([M][L3][T-3][I-2]) More...
class	solid_angle_t
	quantity for values with dimension tag solid_angle ([1]) More...
class	surface_activity_t
	quantity for values with dimension tag surface_activity ([L-2][T-1]) More...
class	surface_density_t
	quantity for values with dimension tag surface_density ([M][L-2]) More...
class	surface_t
	quantity for values with dimension tag surface ([L2]) More...
class	surface_tension_t
	quantity for values with dimension tag surface_tension ([M][T-2]) More...
class	temperature_t
	quantity for values with dimension tag temperature ([theta]) More...
class	time_t
	quantity for values with dimension tag time ([T]) More...
class	unknown_unit_error
	Exception reporting unknown unit tags. More...
class	velocity_t
	quantity for values with dimension tag velocity ([L][T-1]) More...
class	volume_activity_t
	quantity for values with dimension tag volume_activity ([L-3][T-1]) More...
class	volume_t
	quantity for values with dimension tag volume ([L3]) More...
class	wave_number_t
	quantity for values with dimension tag wave_number ([L-1]) More...
class	wrong_dimension_error
	Exception reporting wrong or incompatible dimensions. More...
class	wrong_type_error

Typedefs
typedef std::logic_error	WrongType
typedef std::logic_error	MissingKey
typedef boost::mpl::vector< int, double, bool, std::string, std::vector< int >, std::vector< double >, std::vector< bool >, std::vector< std::string > >	AllowedTypes
	List of types that can be stored in and read from datatools::properties. More...

Functions
std::ostream &	operator<< (std::ostream &os, path const &p)
	Output path to an ostream. More...
template<typename T >
T	getRequiredValue (const datatools::properties &p, const std::string &key)
template<typename T >
T	getValueOrDefault (const datatools::properties &p, const std::string &key, T defaultValue)
void	make_property_set (const std::string &filename, property_set &ps)
	Construct a property_set from an input datatools::properties file. More...

Typedef Documentation

AllowedTypes

typedef boost::mpl::vector<int, double, bool, std::string, std::vector<int>, std::vector<double>, std::vector<bool>, std::vector<std::string> > falaise::config::AllowedTypes

List of types that can be stored in and read from datatools::properties.

MissingKey

typedef std::logic_error falaise::config::MissingKey

WrongType

typedef std::logic_error falaise::config::WrongType

Function Documentation

getRequiredValue()

template<typename T >

T falaise::config::getRequiredValue	(	const datatools::properties &	p,
		const std::string &	key
	)

getValueOrDefault()

template<typename T >

T falaise::config::getValueOrDefault	(	const datatools::properties &	p,
		const std::string &	key,
		T	defaultValue
	)

make_property_set()

void falaise::config::make_property_set	(	const std::string &	filename,
		property_set &	ps
	)

Construct a property_set from an input datatools::properties file.

Parameters

filename	File from which to read data
ps	property_set to fill with data

operator<<()

std::ostream& falaise::config::operator<< ( std::ostream &  os, path const &  p  )

inline

Output path to an ostream.