ProgSettings Class Reference

A class that stores the general program settings of Paramotopy. More...

#include <xml_preferences.hpp>

Collaboration diagram for ProgSettings:

Public Types
enum	{ NUMMANDATORY_SAVEFILES = 1, NUMPOSSIBLE_SAVEFILES = 7, TOTALFILES = 8 }

Public Member Functions
void	save ()
void	save (boost::filesystem::path save_filename)
int	check_for_existing_prefs_auto (boost::filesystem::path &load_filename, boost::filesystem::path pFilename)
boost::filesystem::path	default_name ()
boost::filesystem::path	make_settings_name (boost::filesystem::path basename)
void	set_name (boost::filesystem::path newfilename)
void	load_interactive ()
void	load (boost::filesystem::path pFilename)
void	load ()
	ProgSettings ()
	ProgSettings (boost::filesystem::path tempfilename)
	~ProgSettings ()
void	setValue (std::string categoryName, std::string settingName, std::string settingValue)
void	setValue (std::string categoryName, std::string settingName, double settingValue)
void	setValue (std::string categoryName, std::string settingName, int settingValue)
void	setValue (std::string categoryName, std::string settingName, boost::filesystem::path settingValue)
void	GetParallel ()
void	GetArchitecture ()
void	GetSaveProgress ()
void	GetNewFileThresh ()
void	GetTemporaryFileLocation ()
void	GetStifle ()
void	GetMachineFile ()
void	GetNumProcs ()
void	GetNumFilesTime ()
void	GetDeleteTmpFiles ()
void	GetWriteMCFileUserDef ()
void	GetStartFileName ()
void	GetDataFolderMethod ()
void	GetNewRandomAtNewFolder ()
void	GetRandomMethod ()
void	GetTightenTolerancesPathFailure ()
void	GetNumIterations ()
void	GetBufferSize ()
void	SetSaveFiles ()
bool	CheckPrevSetFiles ()
void	GetProgramLocationManual (std::string program_name, std::string category_name, std::string setting_name)
void	FindProgram (std::string program_name, std::string category_name, std::string setting_name)
void	MainMenu ()
void	BertiniMenu ()
void	StepOneMenu ()
void	StepTwoMenu ()
void	PathFailureMenu ()
void	SaveFilesMenu ()
void	ParallelismMenu ()
void	GeneralMenu ()
void	SetSearchMode ()
void	SetSearchIterations ()
void	SetSearchSubmode ()
void	SetSearchPosRealThresh ()
void	SetSearchDesiredNumber ()
void	SearchMenu ()
void	SolverModeMenu ()
void	SystemMenu ()
void	FileMenu ()
void	ManagePathFailureBertini ()
void	MetaSettingsMenu ()
void	default_main_values ()
void	default_basic_bertini_values_stepone ()
void	default_basic_bertini_values_steptwo ()
void	default_basic_bertini_values_pathfailure ()
void	default_path_failure_settings ()
void	DisplayCurrentSettings (std::string category_name)
void	ChangeSetting (std::string category_name)
void	AddSetting (std::string category_name)
void	RemoveSetting (std::string category_name)
std::string	WriteConfigStepOne ()
std::string	WriteConfigStepTwo ()
std::string	WriteConfigFail ()
void	set_path_failure_settings ()
void	set_path_failure_settings_from_steptwo ()
void	tightentolerances ()
void	SetStandardStep2 ()

Public Attributes
int	version
categorymap	settings

Static Public Attributes
static const char *const	possible_savefiles [NUMPOSSIBLE_SAVEFILES]
static const char *const	mandatory_savefiles [NUMMANDATORY_SAVEFILES]

Private Member Functions
bool	setRequiredValues ()
bool	haveSetting (std::string category_name, std::string setting_name)
void	RequiredSettingsSwitcharoo (int settingcase)
int	SaveCategoryToXml (std::string catname, settingmap curr_settings, TiXmlElement *root)
int	ReadCategoryFromXml (std::string catname, TiXmlHandle hroot)

Private Attributes
boost::filesystem::path	filename

Detailed Description

A class that stores the general program settings of Paramotopy.

Definition at line 131 of file xml_preferences.hpp.

Member Enumeration Documentation

anonymous enum

Enumerator
NUMMANDATORY_SAVEFILES
NUMPOSSIBLE_SAVEFILES
TOTALFILES

Definition at line 136 of file xml_preferences.hpp.

Constructor & Destructor Documentation

ProgSettings::ProgSettings ( )

inline

Definition at line 198 of file xml_preferences.hpp.

ProgSettings::ProgSettings ( boost::filesystem::path  tempfilename )

inline

Parameters

tempfilename

- Set the filename data member to tempfilename.

Definition at line 200 of file xml_preferences.hpp.

References filename.

ProgSettings::~ProgSettings ( )

inline

Default Deconstructor.

Definition at line 202 of file xml_preferences.hpp.

Member Function Documentation

void ProgSettings::AddSetting

(

std::string

category_name

)

Add a setting of the given category.

Parameters

category_name

- The given category.

Definition at line 1113 of file xml_preferences.cpp.

References get_int_choice(), getAlphaNumeric(), save(), and setValue().

Referenced by ManagePathFailureBertini(), StepOneMenu(), and StepTwoMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::BertiniMenu

(

)

Chain into the bertini settings menus.

Definition at line 1321 of file xml_preferences.cpp.

References get_int_choice(), ManagePathFailureBertini(), StepOneMenu(), and StepTwoMenu().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::ChangeSetting

(

std::string

category_name

)

Change the setting of the given category.

Parameters

category_name

- The given category.

Definition at line 1059 of file xml_preferences.cpp.

References getAlphaNumeric(), haveSetting(), save(), settings, and setValue().

Referenced by ManagePathFailureBertini(), StepOneMenu(), and StepTwoMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

int ProgSettings::check_for_existing_prefs_auto	(	boost::filesystem::path &	load_filename,
		boost::filesystem::path	pFilename
	)

Save the xml file to the hard disk. This function uses the boost library directory and path structures.

Parameters

speciallocation	- The file to where the xml file is to be saved. find existing preferences file, based on input
pFilename	- The preference file name.

Returns

int found_a_file whether found a file to load or not. 0 if no file, even default. 1 if found desired file. 2 if found defaults.

bool load_filename the string which is the name of the file.

Definition at line 707 of file xml_preferences.cpp.

References default_name().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ProgSettings::CheckPrevSetFiles

(

)

Parameters

datafilename

- Determine if datafilename is to be saved or not. ? ?

Definition at line 594 of file xml_preferences.cpp.

References NUMPOSSIBLE_SAVEFILES, possible_savefiles, and settings.

Referenced by load().

Here is the caller graph for this function:

void ProgSettings::default_basic_bertini_values_pathfailure

(

)

Set the default path failure settings to be used in bertini.

Definition at line 255 of file xml_preferences.cpp.

References save(), settings, and setValue().

Referenced by load(), ManagePathFailureBertini(), and PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::default_basic_bertini_values_stepone

(

)

Set the default bertini step 1 values.

Definition at line 230 of file xml_preferences.cpp.

References save(), settings, and setValue().

Referenced by load(), and StepOneMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::default_basic_bertini_values_steptwo

(

)

Set the default bertini step 2 values.

Definition at line 243 of file xml_preferences.cpp.

References save(), settings, and setValue().

Referenced by load(), and StepTwoMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::default_main_values

(

)

Set the default values of the program.

Definition at line 188 of file xml_preferences.cpp.

References mandatory_savefiles, NUMMANDATORY_SAVEFILES, NUMPOSSIBLE_SAVEFILES, possible_savefiles, and setValue().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

boost::filesystem::path ProgSettings::default_name

(

)

get the name of the default paramotopy settings xml file

Definition at line 734 of file xml_preferences.cpp.

Referenced by check_for_existing_prefs_auto(), load(), and MetaSettingsMenu().

Here is the caller graph for this function:

void ProgSettings::default_path_failure_settings

(

)

Set the default path failure settings.

Definition at line 266 of file xml_preferences.cpp.

References save(), and setValue().

Referenced by load(), and PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::DisplayCurrentSettings

(

std::string

category_name

)

Display all the settings of the given category.

Parameters

category_name

- The given category.

Definition at line 1201 of file xml_preferences.cpp.

References settings.

Referenced by FileMenu(), failinfo::MainMenu(), ManagePathFailureBertini(), ParallelismMenu(), PathFailureMenu(), SaveFilesMenu(), SearchMenu(), SolverModeMenu(), StepOneMenu(), StepTwoMenu(), and SystemMenu().

Here is the caller graph for this function:

void ProgSettings::FileMenu

(

)

Menu for memory management.

Definition at line 1576 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), GetDataFolderMethod(), GetDeleteTmpFiles(), GetNewFileThresh(), GetNewRandomAtNewFolder(), GetTemporaryFileLocation(), and GetWriteMCFileUserDef().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::FindProgram	(	std::string	program_name,
		std::string	category_name,
		std::string	setting_name
	)

Find the locaton of the step2 and bertini binaries.

Definition at line 467 of file xml_preferences.cpp.

References getAlphaNumeric(), haveSetting(), settings, and setValue().

Referenced by load(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GeneralMenu

(

)

Display the general options menu.

void ProgSettings::GetArchitecture

(

)

Get the architecture setting.

Definition at line 1989 of file xml_preferences.cpp.

References get_int_choice(), getAlphaNumeric_WithSpaces(), and setValue().

Referenced by ParallelismMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetBufferSize

(

)

Get the buffer size of information to be stored in memory before writing to the disk.

Definition at line 2121 of file xml_preferences.cpp.

References get_int_choice(), and setValue().

Referenced by RequiredSettingsSwitcharoo(), and SystemMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetDataFolderMethod

(

)

Get the data folder method setting.

Definition at line 2391 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetDeleteTmpFiles

(

)

Get the delete temp file setting.

Definition at line 2093 of file xml_preferences.cpp.

References get_int_choice(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetMachineFile

(

)

Get the machine file location.

Definition at line 2020 of file xml_preferences.cpp.

References get_int_choice(), getAlphaNumeric(), settings, and setValue().

Referenced by GetParallel(), and ParallelismMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetNewFileThresh

(

)

Get the new file threshold setting.

Definition at line 2108 of file xml_preferences.cpp.

References get_int_choice(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetNewRandomAtNewFolder

(

)

Get the data folder method setting.

Definition at line 2436 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetNumFilesTime

(

)

Get the number of files at a time to save. ?

Definition at line 2080 of file xml_preferences.cpp.

References get_int_choice(), and setValue().

Referenced by ParallelismMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetNumIterations

(

)

Get the number of iterations to be performed during path failure resolution.

Definition at line 2474 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetNumProcs

(

)

Get the number of processors to be used.

Definition at line 2074 of file xml_preferences.cpp.

References get_int_choice(), and setValue().

Referenced by GetParallel(), and ParallelismMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetParallel

(

)

A function to set the value of a given category and setting.

Parameters

categoryName	- The category name in which to search for the settingName.
settingName	- The setting name in which to store settingValue.
settingValue	- The value to store as an int.Get the parallel setting.

Definition at line 1963 of file xml_preferences.cpp.

References get_int_choice(), GetMachineFile(), GetNumProcs(), and setValue().

Referenced by ParallelismMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetProgramLocationManual	(	std::string	program_name,
		std::string	category_name,
		std::string	setting_name
	)

Display the location of the step2 and bertini binaries.

Definition at line 431 of file xml_preferences.cpp.

References getAlphaNumeric(), replace_tilde_with_home(), and setValue().

Referenced by SystemMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetRandomMethod

(

)

Get the random method setting.

Definition at line 2460 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetSaveProgress

(

)

Get the save progress setting.

Definition at line 2100 of file xml_preferences.cpp.

References setValue().

Referenced by RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetStartFileName

(

)

Get the start file name setting.

Definition at line 2408 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by RequiredSettingsSwitcharoo(), and SolverModeMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetStifle

(

)

Get the stifle output setting.

Definition at line 2201 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by RequiredSettingsSwitcharoo(), and SystemMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetTemporaryFileLocation

(

)

Get the temporary file location.

Definition at line 2135 of file xml_preferences.cpp.

References get_int_choice(), getAlphaNumeric(), save(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetTightenTolerancesPathFailure

(

)

Get the tighten tolerances in the path failure resolution settings.

Definition at line 2468 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::GetWriteMCFileUserDef

(

)

Get the write monte carlo file user defined setting.

Definition at line 2212 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by FileMenu(), and RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ProgSettings::haveSetting ( std::string  category_name, std::string  setting_name  )

inlineprivate

Test if a category of category_name has a setting of setting_name.

Parameters

category_name	- The category.
setting_name	- The setting.

Returns

bool - True if the setting_name was found within that category. False, otherwise.

Definition at line 404 of file xml_preferences.hpp.

Referenced by ChangeSetting(), FindProgram(), and RemoveSetting().

Here is the caller graph for this function:

void ProgSettings::load

(

boost::filesystem::path

pFilename

)

Load the xml preference file.

Parameters

pFilename

- The preference file name.

Definition at line 797 of file xml_preferences.cpp.

References check_for_existing_prefs_auto(), CheckPrevSetFiles(), default_basic_bertini_values_pathfailure(), default_basic_bertini_values_stepone(), default_basic_bertini_values_steptwo(), default_main_values(), default_name(), default_path_failure_settings(), filename, FindProgram(), ReadCategoryFromXml(), save(), setRequiredValues(), SetSaveFiles(), and settings.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::load ( )

inline

Load the xml preference file with the current saved filename.

Definition at line 195 of file xml_preferences.hpp.

References filename, and load().

Referenced by load(), and load_interactive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::load_interactive

(

)

an interactive way to choose a set of settings to load.

Definition at line 751 of file xml_preferences.cpp.

References FindFiles(), get_int_choice(), and load().

Referenced by MetaSettingsMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::MainMenu

(

)

Display paramotopy's main menu.

Definition at line 1255 of file xml_preferences.cpp.

References BertiniMenu(), FileMenu(), get_int_choice(), MetaSettingsMenu(), ParallelismMenu(), PathFailureMenu(), SaveFilesMenu(), SolverModeMenu(), and SystemMenu().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

boost::filesystem::path ProgSettings::make_settings_name

(

boost::filesystem::path

basename

)

gets ~/.paramotopy/prefsfilename.xml

Definition at line 741 of file xml_preferences.cpp.

Referenced by main().

Here is the caller graph for this function:

void ProgSettings::ManagePathFailureBertini

(

)

Display the path failure options for bertini menu.

Definition at line 1005 of file xml_preferences.cpp.

References AddSetting(), ChangeSetting(), default_basic_bertini_values_pathfailure(), DisplayCurrentSettings(), get_int_choice(), RemoveSetting(), save(), set_path_failure_settings_from_steptwo(), and settings.

Referenced by BertiniMenu(), and PathFailureMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::MetaSettingsMenu

(

)

perform meta-settings actions

Definition at line 1879 of file xml_preferences.cpp.

References default_name(), filename, get_int_choice(), load_interactive(), and save().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::ParallelismMenu

(

)

Display the parallelism options menu.

Definition at line 1638 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), GetArchitecture(), GetMachineFile(), GetNumFilesTime(), GetNumProcs(), and GetParallel().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::PathFailureMenu

(

)

Display the path failure options menu.

Definition at line 1794 of file xml_preferences.cpp.

References default_basic_bertini_values_pathfailure(), default_path_failure_settings(), DisplayCurrentSettings(), get_int_choice(), GetNumIterations(), GetRandomMethod(), GetTightenTolerancesPathFailure(), ManagePathFailureBertini(), save(), and settings.

Referenced by failinfo::MainMenu(), and MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

int ProgSettings::ReadCategoryFromXml ( std::string  catname, TiXmlHandle  hroot  )

private

Read a category from xml.

Parameters

catname	- The category name.
hroot	- The handle of the root of catname.

Definition at line 919 of file xml_preferences.cpp.

References setValue().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::RemoveSetting

(

std::string

category_name

)

Remove a setting of the given category.

Parameters

category_name

- The given category.

Definition at line 1167 of file xml_preferences.cpp.

References getAlphaNumeric(), haveSetting(), save(), and settings.

Referenced by ManagePathFailureBertini(), StepOneMenu(), and StepTwoMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::RequiredSettingsSwitcharoo ( int  settingcase )

private

Definition at line 278 of file xml_preferences.cpp.

References FindProgram(), GetArchitecture(), GetBufferSize(), GetDataFolderMethod(), GetDeleteTmpFiles(), GetNewFileThresh(), GetNewRandomAtNewFolder(), GetNumFilesTime(), GetParallel(), GetSaveProgress(), GetStartFileName(), GetStifle(), GetTemporaryFileLocation(), GetWriteMCFileUserDef(), SetSearchMode(), and SetStandardStep2().

Referenced by setRequiredValues().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::save ( )

inline

Save the xml file to the hard disk.

Definition at line 149 of file xml_preferences.hpp.

References filename.

Referenced by AddSetting(), ChangeSetting(), default_basic_bertini_values_pathfailure(), default_basic_bertini_values_stepone(), default_basic_bertini_values_steptwo(), default_path_failure_settings(), GetDataFolderMethod(), GetNewRandomAtNewFolder(), GetNumIterations(), GetRandomMethod(), GetStartFileName(), GetStifle(), GetTemporaryFileLocation(), GetTightenTolerancesPathFailure(), GetWriteMCFileUserDef(), load(), ManagePathFailureBertini(), MetaSettingsMenu(), PathFailureMenu(), RemoveSetting(), SearchMenu(), set_path_failure_settings(), set_path_failure_settings_from_steptwo(), SetSaveFiles(), SetSearchDesiredNumber(), SetSearchIterations(), SetSearchMode(), SetSearchPosRealThresh(), SetSearchSubmode(), SetStandardStep2(), steptwo_case(), and tightentolerances().

Here is the caller graph for this function:

void ProgSettings::save

(

boost::filesystem::path

save_filename

)

Save the xml file to the hard disk.

Parameters

pFilename

- The file to where the xml file is to be saved.

Definition at line 626 of file xml_preferences.cpp.

References SaveCategoryToXml(), and settings.

Here is the call graph for this function:

int ProgSettings::SaveCategoryToXml ( std::string  catname, settingmap  curr_settings, TiXmlElement *  root  )

private

Save a category with the current settings to xml.

Parameters

catname	- The category name.
curr_settings	- The current settings.
root	- A pointer to the root of the TiXmlElement (of catname ? ).

Definition at line 658 of file xml_preferences.cpp.

Referenced by save().

Here is the caller graph for this function:

void ProgSettings::SaveFilesMenu

(

)

Display the saved files options menu.

Definition at line 1849 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), and SetSaveFiles().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SearchMenu

(

)

menu for search mode.

Definition at line 1415 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), save(), SetSearchDesiredNumber(), SetSearchIterations(), SetSearchPosRealThresh(), SetSearchSubmode(), settings, and setValue().

Referenced by SolverModeMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::set_name ( boost::filesystem::path  newfilename )

inline

sets the .filename field to whatever you put in

Definition at line 182 of file xml_preferences.hpp.

References filename.

Referenced by main().

Here is the caller graph for this function:

void ProgSettings::set_path_failure_settings

(

)

Set the path failure settings (for step 1 ? ).

Definition at line 149 of file xml_preferences.cpp.

References save(), settings, and setValue().

Referenced by failinfo::MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::set_path_failure_settings_from_steptwo

(

)

Set the path failure settings from (for? - rename function?) step 2.

Definition at line 122 of file xml_preferences.cpp.

References save(), settings, and setValue().

Referenced by ManagePathFailureBertini().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ProgSettings::setRequiredValues ( )

private

Set the required values.

Definition at line 367 of file xml_preferences.cpp.

References RequiredSettingsSwitcharoo(), and settings.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSaveFiles

(

)

Set the files from the bertini ouptut to save.

FilePrefVector[j]

Definition at line 560 of file xml_preferences.cpp.

References get_int_choice(), mandatory_savefiles, NUMMANDATORY_SAVEFILES, NUMPOSSIBLE_SAVEFILES, possible_savefiles, save(), settings, and setValue().

Referenced by load(), and SaveFilesMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSearchDesiredNumber

(

)

get the number of desired solutions for a pos real search

Definition at line 2219 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by SearchMenu(), and SetSearchMode().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSearchIterations

(

)

get the number of iterations for a pos real search

Definition at line 2239 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by SearchMenu(), and SetSearchMode().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSearchMode

(

)

main switch for solver modes.

Definition at line 2324 of file xml_preferences.cpp.

References get_int_choice(), save(), SetSearchDesiredNumber(), SetSearchIterations(), SetSearchSubmode(), settings, and setValue().

Referenced by RequiredSettingsSwitcharoo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSearchPosRealThresh

(

)

get the threshold for number of positive real solutions occurring at any point

Definition at line 2296 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by SearchMenu(), and SetSearchSubmode().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetSearchSubmode

(

)

switch between accumulating a specific number of solutions, or a number of points with a desired number of positive real solutions

Definition at line 2265 of file xml_preferences.cpp.

References get_int_choice(), save(), SetSearchPosRealThresh(), settings, and setValue().

Referenced by SearchMenu(), and SetSearchMode().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SetStandardStep2

(

)

Ask the user to enter the standard step2 option.

Definition at line 2378 of file xml_preferences.cpp.

References get_int_choice(), save(), and setValue().

Referenced by RequiredSettingsSwitcharoo(), and SolverModeMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::setValue ( std::string  categoryName, std::string  settingName, std::string  settingValue  )

inline

A function to set the value of a given category and setting.

Parameters

categoryName	- The category name in which to search for the settingName.
settingName	- The setting name in which to store settingValue.
settingValue	- The value to store as a string.

Definition at line 210 of file xml_preferences.hpp.

Referenced by AddSetting(), ChangeSetting(), default_basic_bertini_values_pathfailure(), default_basic_bertini_values_stepone(), default_basic_bertini_values_steptwo(), default_main_values(), default_path_failure_settings(), FindProgram(), GetArchitecture(), GetBufferSize(), GetDataFolderMethod(), GetDeleteTmpFiles(), GetMachineFile(), GetNewFileThresh(), GetNewRandomAtNewFolder(), GetNumFilesTime(), GetNumIterations(), GetNumProcs(), GetParallel(), GetProgramLocationManual(), GetRandomMethod(), GetSaveProgress(), GetStartFileName(), GetStifle(), GetTemporaryFileLocation(), GetTightenTolerancesPathFailure(), GetWriteMCFileUserDef(), failinfo::new_step_one(), failinfo::PerformAnalysis(), ReadCategoryFromXml(), SearchMenu(), set_path_failure_settings(), set_path_failure_settings_from_steptwo(), SetSaveFiles(), SetSearchDesiredNumber(), SetSearchIterations(), SetSearchMode(), SetSearchPosRealThresh(), SetSearchSubmode(), and SetStandardStep2().

Here is the caller graph for this function:

void ProgSettings::setValue ( std::string  categoryName, std::string  settingName, double  settingValue  )

inline

A function to set the value of a given category and setting.

Parameters

categoryName	- The category name in which to search for the settingName.
settingName	- The setting name in which to store settingValue.
settingValue	- The value to store as a double.

Definition at line 217 of file xml_preferences.hpp.

void ProgSettings::setValue ( std::string  categoryName, std::string  settingName, int  settingValue  )

inline

A function to set the value of a given category and setting.

Parameters

categoryName	- The category name in which to search for the settingName.
settingName	- The setting name in which to store settingValue.
settingValue	- The value to store as an int.

Definition at line 225 of file xml_preferences.hpp.

void ProgSettings::setValue ( std::string  categoryName, std::string  settingName, boost::filesystem::path  settingValue  )

inline

Definition at line 229 of file xml_preferences.hpp.

void ProgSettings::SolverModeMenu

(

)

Menu for Solver modes.

Definition at line 1367 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), GetStartFileName(), SearchMenu(), and SetStandardStep2().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::StepOneMenu

(

)

Display the step one options menu.

Definition at line 1692 of file xml_preferences.cpp.

References AddSetting(), ChangeSetting(), default_basic_bertini_values_stepone(), DisplayCurrentSettings(), get_int_choice(), RemoveSetting(), and settings.

Referenced by BertiniMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::StepTwoMenu

(

)

Display the step two options menu.

Definition at line 1743 of file xml_preferences.cpp.

References AddSetting(), ChangeSetting(), default_basic_bertini_values_steptwo(), DisplayCurrentSettings(), get_int_choice(), RemoveSetting(), and settings.

Referenced by BertiniMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::SystemMenu

(

)

Menu for system interaction.

Definition at line 1526 of file xml_preferences.cpp.

References DisplayCurrentSettings(), get_int_choice(), GetBufferSize(), GetProgramLocationManual(), and GetStifle().

Referenced by MainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

void ProgSettings::tightentolerances

(

)

Set whether or not to automatically tighten the tolerances on the path failure settings.

Definition at line 111 of file xml_preferences.cpp.

References save(), and settings.

Referenced by failinfo::PerformAnalysis().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ProgSettings::WriteConfigFail

(

)

Write the bertini configuration portion of the failed paths runs run.

Definition at line 75 of file xml_preferences.cpp.

References settings.

Referenced by WriteFailStep2().

Here is the caller graph for this function:

std::string ProgSettings::WriteConfigStepOne

(

)

Write the bertini configuration portion of the bertini step 1 run.

Definition at line 26 of file xml_preferences.cpp.

References settings.

Referenced by WriteStep1().

Here is the caller graph for this function:

std::string ProgSettings::WriteConfigStepTwo

(

)

Write the bertini configuration portion of the bertini step 2 run.

Definition at line 47 of file xml_preferences.cpp.

References settings.

Referenced by WriteStep2().

Here is the caller graph for this function:

Member Data Documentation

boost::filesystem::path ProgSettings::filename

private

The name of the preferences file

Definition at line 396 of file xml_preferences.hpp.

Referenced by load(), MetaSettingsMenu(), ProgSettings(), save(), and set_name().

const char *const ProgSettings::mandatory_savefiles

static

Initial value:

=
{ "failed_paths" }

Definition at line 139 of file xml_preferences.hpp.

Referenced by default_main_values(), and SetSaveFiles().

const char *const ProgSettings::possible_savefiles

static

Initial value:

=
{ "real_solutions", "nonsingular_solutions", "singular_solutions", "raw_data", "raw_solutions","main_data","midpath_data"   }

Definition at line 138 of file xml_preferences.hpp.

Referenced by CheckPrevSetFiles(), default_main_values(), and SetSaveFiles().

categorymap ProgSettings::settings

A map of maps, holding settings for the various categories.

Definition at line 145 of file xml_preferences.hpp.

Referenced by datagatherer::AppendOnlyPosReal(), CallBertiniStep1(), ChangeSetting(), CheckPrevSetFiles(), master_process::CleanupBasic(), master_process::CleanupSwitch(), default_basic_bertini_values_pathfailure(), default_basic_bertini_values_stepone(), default_basic_bertini_values_steptwo(), DisplayCurrentSettings(), FindProgram(), GetMachineFile(), master_process::GetTerminationInt(), load(), master_process::LoopBasic(), master_process::LoopSearch(), slave_process::LoopSearch(), master_process::LoopSwitch(), slave_process::LoopSwitch(), main(), runinfo::MakeVariableGroups(), ManagePathFailureBertini(), master_process::MasterSetup(), failinfo::new_step_one(), master_process::OpenMC(), parallel_case(), PathFailureMenu(), failinfo::PerformAnalysis(), RemoveSetting(), save(), SearchMenu(), master_process::SeedBasic(), master_process::SeedSearch(), master_process::SeedSwitch(), master_process::SendStart(), set_path_failure_settings(), set_path_failure_settings_from_steptwo(), setRequiredValues(), SetSaveFiles(), SetSearchMode(), SetSearchSubmode(), master_process::SetTmpFolder(), slave_process::SetWorkingFolder(), datagatherer::SlaveCollectAndWriteData(), slave_process::SlaveSetup(), datagatherer::SlaveSetup(), StepOneMenu(), steptwo_case(), StepTwoMenu(), tightentolerances(), WriteConfigFail(), WriteConfigStepOne(), WriteConfigStepTwo(), WriteFailStep2(), and WriteStep2().

int ProgSettings::version

The current version.

Definition at line 143 of file xml_preferences.hpp.

---

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

• /Users/ofloveandhate/paramotopy/dev_folder/paramotopy/include/xml_preferences.hpp
• /Users/ofloveandhate/paramotopy/dev_folder/paramotopy/src/xml_preferences.cpp