Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   Related Pages  

ObjCryst::RefParType Class Reference

class of refinable parameter types. More...

#include <RefinableObj.h>

List of all members.

Public Methods

 RefParType (const string &name)
 Create a top parameter type. (in ObjCryst, there is only one, the "ObjCryst" category.

 RefParType (const RefParType *parent, const string &name)
 create a children type.

 ~RefParType ()
 Destructor.

bool IsDescendantFromOrSameAs (const RefParType *type) const
 Returns true if the parameter is a descendant of 'type'.

bool operator== (const RefParType *parent) const
 returns true if the two types are the same.

const string & GetName () const
 Get the name for this parameter.


Private Attributes

const RefParType * mpParent
 the parent for this RefParType (we could easily allow several...).

const string mName
 The name/description for this parameter type.


Detailed Description

class of refinable parameter types.

This is used to categorize all parameters, to be able to modify a complete category of parameters (fix/unfix, set limits,...). The types are organized as a tree.

Parameters should be allocated globally in the heap, so we only use pointers in the interface.

Note:
when modifying (fixing, changing limits) for a given RefParType (ie a 'family' of parameters), it affects all RefinablePar of this type and the parameters belonging to the children of this RefParType. eg fixing for the type "gpRefParTypeScatt" will fix all the derived postionnal, orientationnal, and population parameters for the scatterers.
Remarks:
In the future, why not use a tree with multiple inheritance ?? It would be easy to allow multiple parents... But beware of loops...


The documentation for this class was generated from the following file:
Generated on Wed Nov 14 19:48:37 2001 for ObjCryst++ by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001