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

#include <SimpleOscillator.hxx>

List of all members.

Public Types

enum  tEnum { pitch = 0, amplitude, modidx, phase }
- Public Types inherited from CLAM::Enum
typedef int tValue

Public Member Functions

 EOscillatorControls ()
 EOscillatorControls (tValue v)
 EOscillatorControls (std::string s)
 ~EOscillatorControls ()
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

Definition at line 37 of file SimpleOscillator.hxx.


Member Enumeration Documentation

Enumerator:
pitch 
amplitude 
modidx 
phase 

Definition at line 50 of file SimpleOscillator.hxx.


Constructor & Destructor Documentation

CLAM::EOscillatorControls::EOscillatorControls ( )
inline

Definition at line 41 of file SimpleOscillator.hxx.

Referenced by Species().

CLAM::EOscillatorControls::EOscillatorControls ( tValue  v)
inline

Definition at line 42 of file SimpleOscillator.hxx.

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

Definition at line 43 of file SimpleOscillator.hxx.

CLAM::EOscillatorControls::~EOscillatorControls ( )
inline

Definition at line 44 of file SimpleOscillator.hxx.


Member Function Documentation

Component* CLAM::EOscillatorControls::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 46 of file SimpleOscillator.hxx.

References EOscillatorControls().

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

Definition at line 57 of file SimpleOscillator.hxx.

References amplitude, modidx, NULL, phase, and pitch.


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