VParameterNode Class Reference
[ConfigHandler - Runtime configuration from command line or config files]

Abstract class with iostream operators to store specialized templates in STL containers. More...

#include <VParameterNode.hh>

Inheritance diagram for VParameterNode:

List of all members.

Public Member Functions
	VParameterNode (const std::string key="", const std::string helptext="")
	Default Constructor.
virtual	~VParameterNode ()
	Destructor.
virtual bool	SaveToFile (const char *fname, bool showhelp=false)
	Save this parameter to a file.
virtual bool	ReadFromFile (const char *fname, const std::string &key="", bool suppress_errs=false)
	Read this parameter froma file by name <key>, return true on error.
virtual std::istream &	ReadFrom (std::istream &in, bool single=false)=0
	Read this parameter from an istream.
virtual std::istream &	ReadFromByKey (std::istream &in, const std::string &key, bool suppress_errs=false)
	Read this parameter identified by <key> from an istream.
virtual std::ostream &	WriteTo (std::ostream &out, bool showhelp=false, int indent=0) const =0
	Write this parameter to an ostream.
const std::string &	GetDefaultKey () const
	Get the default name of this parameter.
void	SetDefaultKey (const std::string &key)
	Set the default name of this parameter.
int	GetNodeType ()
	Determine what type of parameter node this is.
virtual int	PrintHelp (const std::string &myname="") const
	Print information about this parameter, and travel the tree.
const std::string &	GetHelpText ()
	Get the associated help text.
void	SetHelpText (const std::string &newtext)
	Set the associated help text.
virtual VParameterNode *	Clone (const void *from, void *to) const =0
	Clone the object onto a new parameter list.
Public Attributes
bool	hasread
	Does the underlying object have an istream overload?
bool	haswrite
	Does the underlying object have ostream overload?
Protected Types
enum	NODE_TYPES { VIRTUAL = 0, PARAMETER = 1, PARAMETER_LIST = 2, FUNCTION = 3 }
	Different types of nodes inheriting from VParameterNode.
Protected Attributes
std::string	_default_key
	Default name of this parameter.
int	_node_type
	what NODE_TYPE is this parameter?
std::string	_helptext
	A short description of this parameter.

---

Detailed Description

Abstract class with iostream operators to store specialized templates in STL containers.

Definition at line 22 of file VParameterNode.hh.

---

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

• ConfigHandler/include/VParameterNode.hh
• ConfigHandler/src/VParameterNode.cc