Diffpack Documentation

---

              Search  

---

IndexSet_prm Class Reference

parameters for initialization of the "IndexSet" hierarchy. More...

#include <IndexSet_prm.h>

Inheritance diagram for IndexSet_prm::

List of all members.

Public Methods
virtual	~IndexSet_prm ()
bool	ok () const
bool	operator!= (const IndexSet_prm &indprm)
void	operator= (const IndexSet_prm &indprm)
void	define (MenuSystem &menu, int level=MAIN)
void	scan (MenuSystem &menu)
void	scan (Is is)
void	print (Os os) const
virtual IndexSet*	create () const
const StringList&	hier () const
Static Public Methods
IndexSet_prm*	construct ()
void	defineStatic (MenuSystem &menu, int level=MAIN)
const StringList&	hierStatic ()
void	registerPrmSubclass (IndexSet_prm &sc)
void	unregisterPrmSubclass ()
Public Attributes
String	index_set_storage
int	nsd
String	index_set_string
Protected Methods
virtual IndexSet_prm*	clone ()
	IndexSet_prm ()
Protected Attributes
StringList	subclasses
Static Protected Attributes
Handle(IndexSet_prm)	master
Friends
Os&	operator<< (Os &os, const IndexSet_prm &indprm)
Is&	operator>> (Is &is, IndexSet_prm &indprm)

---

Detailed Description

parameters for initialization of the "IndexSet" hierarchy.

NAME: IndexSet_prm - parameters for initialization of the "IndexSet" hierarchy

DESCRIPTION:

The class contains a collection of all the parameters that may be needed when the base class "IndexSet" is used to construct derived objects.

The constructor without arguments is protected and can hence not be used. Instead, parameter objects are created by the "construct" function, e.g.,

 Handle(IndexSet_prm) pm = IndexSet_prm ::construct();
 // illegal: IndexSet_prm pm;

See the Diffpack FAQ entry on parameter classes for further details.

---

Constructor & Destructor Documentation

IndexSet_prm::IndexSet_prm ( ) [protected]

IndexSet_prm::~IndexSet_prm ( ) [inline, virtual]

---

Member Function Documentation

IndexSet_prm * IndexSet_prm::clone ( ) [inline, protected, virtual]

IndexSet_prm * IndexSet_prm::construct ( ) [static]

IndexSet * IndexSet_prm::create ( ) const [virtual]

creates a subclass object in the "IndexSet" hierarchy with name specified by the string "subclass_name". Can be redefined in subclasses of "IndexSet_prm" if the "IndexSet" hierarchy is extended in a new module.

void IndexSet_prm::define ( MenuSystem & menu, int level = MAIN ) [inline]

see "defineStatic".

static void IndexSet_prm::defineStatic ( MenuSystem & menu, int level = MAIN ) [static]

builds a submenu for initialization of the parameters and links it to the specified "MenuSystem" object.

const StringList & IndexSet_prm::hier ( ) const [inline]

returns a list with the names of all the subclasses in the "IndexSet" hierarchy.

static const StringList & IndexSet_prm::hierStatic ( ) [inline, static]

a version of "hier" that can be called without having a "IndexSet_prm" object. Useful in "defineStatic" functions for providing a list of all the possible choices of a subclass names.

bool IndexSet_prm::ok ( ) const

returns "true" if the parameters are consistent.

bool IndexSet_prm::operator!= ( const IndexSet_prm & indprm )

checks for equality member by member. If one or more items differ, the value "true" is returned.

void IndexSet_prm::operator= ( const IndexSet_prm & indprm )

assigns values from the specified parameter object, member by member.

void IndexSet_prm::print ( Os os ) const

prints the contents of the object to an "Os". An "operator<<" is also available.

static void IndexSet_prm::registerPrmSubclass ( IndexSet_prm & sc ) [inline, static]

allows a user to register his own subclass of "IndexSet_prm" as the version of the parameter class for the "IndexSet" hierarchy to be used by the Diffpack libraries.

void IndexSet_prm::scan ( Is is )

See documentation of one of the overloaded functions.

void IndexSet_prm::scan ( MenuSystem & menu )

read input from an "Is" or form a "MenuSystem" and initializes the object. An "operator>>" is also available.

static void IndexSet_prm::unregisterPrmSubclass ( ) [inline, static]

resets the version of the parameter class for the "IndexSet" hierarchy, to be used by the Diffpack libraries, back to the default choice "IndexSet_prm".

---

Friends And Related Function Documentation

Os & operator<< ( Os & os, const IndexSet_prm & indprm ) [friend]

Is & operator>> ( Is & is, IndexSet_prm & indprm ) [friend]

---

Member Data Documentation

String IndexSet_prm::index_set_storage

String IndexSet_prm::index_set_string

Handle(IndexSet_prm) IndexSet_prm::master [static, protected]

int IndexSet_prm::nsd

StringList IndexSet_prm::subclasses [protected]

---

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

• IndexSet_prm.h

---