CLAM-Development  1.4.0
Public Types | Public Member Functions | Static Public Member Functions
CLAM::EPhaseGeneration Class Reference

PhaseGeneration Enumeration to use for specifying the type of phase generation used. More...

#include <EPhaseGeneration.hxx>

List of all members.

Public Types

enum  tEnum { eAlign, eRandom, eContinuation, eNone }
- Public Types inherited from CLAM::Enum
typedef int tValue

Public Member Functions

 EPhaseGeneration ()
 EPhaseGeneration (tValue v)
 EPhaseGeneration (std::string s)
virtual ComponentSpecies () const
 Returns a new object of the same class than the receiver object.
- Public Member Functions inherited from CLAM::Enum
const tEnumValueGetSymbolMap () const
 Returns the symbol map for the enum.
void SetValue (const tValue v)
 Changes the value.
void SetValueSafely (const tValue v) throw (IllegalValue)
 Changes the value safely.
void SetValue (const std::string &s)
 Changes the value.
void SetValueSafely (const std::string &s) throw (IllegalValue)
tValue GetValue () const
 Returns the numeric value.
std::string GetString () const throw (IllegalValue)
 Returns the symbolic value.
Enumoperator= (const tValue &v) throw (IllegalValue)
Enumoperator= (const std::string &v) throw (IllegalValue)
Enumoperator= (const Enum &v) throw (IllegalValue)
 operator tValue () const
 Conversion operiation as a number.
virtual ComponentDeepCopy () const
 TODO: Copy documentation for this method from Component.
virtual ComponentShallowCopy () const
 TODO: Copy documentation for this method from Component.
virtual void StoreOn (Storage &storage) const
 Stores component's subitems on the given Storage.
virtual void LoadFrom (Storage &storage)
 Loads component's subitems from the given Storage.
virtual ~Enum ()
 The required virtual destructor.
const char * GetClassName () const
 Return the class name.
- Public Member Functions inherited from CLAM::Component
virtual ~Component ()

Static Public Member Functions

static tEnumValueValueTable ()

Additional Inherited Members

 Enum (const tEnumValue *values, const tValue &value)
 Construction with a numeric value.
 Enum (const tEnumValue *values, const std::string &value)
 Construction with a symbolic value.

Detailed Description

PhaseGeneration Enumeration to use for specifying the type of phase generation used.

Definition at line 33 of file EPhaseGeneration.hxx.


Member Enumeration Documentation

Enumerator:
eAlign 
eRandom 
eContinuation 
eNone 

Definition at line 40 of file EPhaseGeneration.hxx.


Constructor & Destructor Documentation

CLAM::EPhaseGeneration::EPhaseGeneration ( )
inline

Definition at line 36 of file EPhaseGeneration.hxx.

Referenced by Species().

CLAM::EPhaseGeneration::EPhaseGeneration ( tValue  v)
inline

Definition at line 37 of file EPhaseGeneration.hxx.

CLAM::EPhaseGeneration::EPhaseGeneration ( std::string  s)
inline

Definition at line 38 of file EPhaseGeneration.hxx.


Member Function Documentation

virtual Component* CLAM::EPhaseGeneration::Species ( ) const
inlinevirtual

Returns a new object of the same class than the receiver object.

To be reimplemented by subclasses.

Returns:
a new allocated component. The pointer belongs to the caller.

Implements CLAM::Enum.

Definition at line 47 of file EPhaseGeneration.hxx.

References EPhaseGeneration().

static tEnumValue* CLAM::EPhaseGeneration::ValueTable ( )
inlinestatic

Definition at line 51 of file EPhaseGeneration.hxx.

References eAlign, eContinuation, eNone, eRandom, and NULL.


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