FOX/ObjCryst++  1.10.X (development)
ObjCryst::RefObjOpt Class Reference

Base class for options. More...

+ Inheritance diagram for ObjCryst::RefObjOpt:
+ Collaboration diagram for ObjCryst::RefObjOpt:

Public Member Functions

 RefObjOpt ()
 Constructor for the option. More...
 
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 RefinableObjClockGetClock () const
 
void XMLOutput (ostream &os, int indent=0) const
 XMLOutput to stream in well-formed XML. More...
 
void XMLInput (istream &is, const XMLCrystTag &tag)
 XMLInput From stream. More...
 

Protected Attributes

int mNbChoice
 Number of different choice possible for this option.
 
int mChoice
 Current value.
 
const string * mpName
 (short) Name for this option. More...
 
const string * mpChoiceName
 Names corresponding to each possible value of this option (Human-understandable). More...
 
RefinableObjClock mClock
 The clock associated to this option.
 

Detailed Description

Base class for options.

Definition at line 550 of file RefinableObj.h.

Constructor & Destructor Documentation

ObjCryst::RefObjOpt::RefObjOpt ( )

Constructor for the option.

Parameters
objthe

Definition at line 734 of file RefinableObj.cpp.

Member Function Documentation

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

XMLInput From stream.

Definition at line 313 of file RefinableObj/IO.cpp.

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.

Definition at line 295 of file RefinableObj/IO.cpp.

Member Data Documentation

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.

Definition at line 587 of file RefinableObj.h.

const string* ObjCryst::RefObjOpt::mpName
protected

(short) Name for this option.

Should be statically stored in the class using the option

Definition at line 584 of file RefinableObj.h.


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