ObjCryst::RefObjOpt Class Reference

Base class for options. More...

Inheritance diagram for ObjCryst::RefObjOpt:

[legend]Collaboration diagram for ObjCryst::RefObjOpt:

[legend]List of all members.

Public Member Functions
	RefObjOpt ()
	Constructor for the option.
virtual	~RefObjOpt ()
void	Init (const int nbChoice, const string *name, const string *choiceNames)
int	GetNbChoice () const
int	GetChoice () const
virtual void	SetChoice (const int choice)
void	SetChoice (const string &choiceName)
const string &	GetName () const
const string &	GetClassName () const
const string &	GetChoiceName (const int i) const
const RefinableObjClock &	GetClock () const
void	XMLOutput (ostream &os, int indent=0) const
	XMLOutput to stream in well-formed XML.
void	XMLInput (istream &is, const XMLCrystTag &tag)
	XMLInput From stream.
Protected Attributes
int	mNbChoice
	Number of different choice possible for this option.
int	mChoice
	Current value.
const string *	mpName
	(short) Name for this option.
const string *	mpChoiceName
	Names corresponding to each possible value of this option (Human-understandable).
RefinableObjClock	mClock
	The clock associated to this option.

---

Detailed Description

Base class for options.

---

Constructor & Destructor Documentation

ObjCryst::RefObjOpt::RefObjOpt (   )

Constructor for the option. Parameters: obj:  the

virtual ObjCryst::RefObjOpt::~RefObjOpt (   )  [virtual]

---

Member Function Documentation

int ObjCryst::RefObjOpt::GetChoice (   )  const

const string& ObjCryst::RefObjOpt::GetChoiceName (  const int  i  )  const

const string& ObjCryst::RefObjOpt::GetClassName (   )  const

const RefinableObjClock& ObjCryst::RefObjOpt::GetClock (   )  const

const string& ObjCryst::RefObjOpt::GetName (   )  const

int ObjCryst::RefObjOpt::GetNbChoice (   )  const

void ObjCryst::RefObjOpt::Init (  const int  nbChoice, const string *  name, const string *  choiceNames )

void ObjCryst::RefObjOpt::SetChoice (  const string &  choiceName  )

virtual void ObjCryst::RefObjOpt::SetChoice (  const int  choice  )  [virtual]

Reimplemented in ObjCryst::RefObjOption< T >.

void ObjCryst::RefObjOpt::XMLInput (  istream &  is, const XMLCrystTag &  tag )

XMLInput From stream.

void ObjCryst::RefObjOpt::XMLOutput (  ostream &  os, int  indent = 0 )  const

XMLOutput to stream in well-formed XML. In this function the name used is that of the Option.

---

Member Data Documentation

int ObjCryst::RefObjOpt::mChoice [protected]

Current value.

RefinableObjClock ObjCryst::RefObjOpt::mClock [protected]

The clock associated to this option.

int ObjCryst::RefObjOpt::mNbChoice [protected]

Number of different choice possible for this option.

const string* ObjCryst::RefObjOpt::mpChoiceName [protected]

Names corresponding to each possible value of this option (Human-understandable). Should be statically stored in the class using the option.

const string* ObjCryst::RefObjOpt::mpName [protected]

(short) Name for this option. Should be statically stored in the class using the option

---

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

• RefinableObj.h

---