SPARK::TPreferenceSettings Class Reference

Wrapper class to store and manipulate information required to initialize the settings for the solution methods for each component. More...

#include <prefs.h>

Collaboration diagram for SPARK::TPreferenceSettings:

[legend]List of all members.

Public Member Functions
Structors
	TPreferenceSettings (const char *prfFileName)
	Loads preference settings from *.prf file named "prfFileName".
	~TPreferenceSettings () throw ()
	Trivial destructor.
Access methods
const char *	GetPrfFileName () const
	Returns the name of the *.prf file used to construct this object as const char* .
TGlobalSettings &	GetGlobalSettings ()
	Returns a reference to the TGlobalSettings object containing the global setting defined in the *.prf file.
const TGlobalSettings &	GetGlobalSettings () const
	Returns a const reference to the TGlobalSettings object containing the global setting defined in the *.prf file.
TComponentSettings &	GetComponentSettings (unsigned compHandle)
	Returns a reference to the TCopmonentSettings object containing the component setting for the component with handle comphandle defined in the *.prf file.
const TComponentSettings &	GetComponentSettings (unsigned compHandle) const
	Returns a const reference to the TCopmonentSettings object containing the component setting for the component with handle comphandle defined in the *.prf file.
I/O Operations
void	Write (std::ostream &os, const std::string &before) const
	Writes the global settings and all component settings to os.

---

Detailed Description

Wrapper class to store and manipulate information required to initialize the settings for the solution methods for each component.

Examples:

multiproblem_example1.cpp, and sparksolver.cpp.

---

Constructor & Destructor Documentation

SPARK::TPreferenceSettings::TPreferenceSettings (  const char *  prfFileName  )

Loads preference settings from *.prf file named "prfFileName".

SPARK::TPreferenceSettings::~TPreferenceSettings (   )  throw ()

Trivial destructor.

---

Member Function Documentation

const char* SPARK::TPreferenceSettings::GetPrfFileName (   )  const [inline]

Returns the name of the *.prf file used to construct this object as const char* .

TGlobalSettings& SPARK::TPreferenceSettings::GetGlobalSettings (   )

Returns a reference to the TGlobalSettings object containing the global setting defined in the *.prf file.

const TGlobalSettings& SPARK::TPreferenceSettings::GetGlobalSettings (   )  const

Returns a const reference to the TGlobalSettings object containing the global setting defined in the *.prf file.

TComponentSettings& SPARK::TPreferenceSettings::GetComponentSettings (  unsigned  compHandle  )

Returns a reference to the TCopmonentSettings object containing the component setting for the component with handle comphandle defined in the *.prf file.

const TComponentSettings& SPARK::TPreferenceSettings::GetComponentSettings (  unsigned  compHandle  )  const

Returns a const reference to the TCopmonentSettings object containing the component setting for the component with handle comphandle defined in the *.prf file.

void SPARK::TPreferenceSettings::Write (  std::ostream &  os, const std::string &  before )  const

Writes the global settings and all component settings to os.

---

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

• prefs.h

---