CLAM::OutControlSenderConfig::EMapping Class Reference

#include <OutControlSender.hxx>

List of all members.

Public Types
enum	tEnum { eLinear, eInverted, eLog, eReverseLog }
Public Types inherited from CLAM::Enum
typedef int	tValue

Public Member Functions
	EMapping ()
	EMapping (tValue v)
	EMapping (std::string s)
Component *	Species () const
	Returns a new object of the same class than the receiver object.
Public Member Functions inherited from CLAM::Enum
const tEnumValue *	GetSymbolMap () 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.
Enum &	operator= (const tValue &v) throw (IllegalValue)
Enum &	operator= (const std::string &v) throw (IllegalValue)
Enum &	operator= (const Enum &v) throw (IllegalValue)
	operator tValue () const
	Conversion operiation as a number.
virtual Component *	DeepCopy () const
	TODO: Copy documentation for this method from Component.
virtual Component *	ShallowCopy () 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 Attributes
static tEnumValue	sEnumValues []
static tValue	sDefault

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 42 of file OutControlSender.hxx.

---

Member Enumeration Documentation

enum CLAM::OutControlSenderConfig::EMapping::tEnum

Enumerator:

eLinear	1:1 relationship (default)
eInverted	Inverted linear relationship.
eLog	More resolution in the low range.
eReverseLog	More resolution in the upper range.

Definition at line 52 of file OutControlSender.hxx.

---

Constructor & Destructor Documentation

CLAM::OutControlSenderConfig::EMapping::EMapping ( )

inline

Definition at line 48 of file OutControlSender.hxx.

Referenced by Species().

CLAM::OutControlSenderConfig::EMapping::EMapping ( tValue  v )

inline

Definition at line 49 of file OutControlSender.hxx.

CLAM::OutControlSenderConfig::EMapping::EMapping ( std::string  s )

inline

Definition at line 50 of file OutControlSender.hxx.

---

Member Function Documentation

Component* CLAM::OutControlSenderConfig::EMapping::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 59 of file OutControlSender.hxx.

References EMapping().

---

Member Data Documentation

Enum::tValue CLAM::OutControlSenderConfig::EMapping::sDefault

static

Initial value:

        OutControlSenderConfig::EMapping::eLinear

Definition at line 47 of file OutControlSender.hxx.

Enum::tEnumValue CLAM::OutControlSenderConfig::EMapping::sEnumValues

static

Initial value:

        {
                { EMapping::eLinear, "Linear" },
                { EMapping::eInverted, "Inverted" },
                { EMapping::eLog, "Log" },
                { EMapping::eReverseLog, "Reverse Log" },
                { 0, NULL }
        }

Definition at line 46 of file OutControlSender.hxx.

---

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

• OutControlSender.hxx
• OutControlSender.cxx