Parameter Class Reference

Search for all occurrences

#include <Parameter.h>

Inheritance diagram for Parameter:

List of all members.

Public Types
enum	Type {   kString, kDouble, kDouble2, kDouble3,   kDouble4, kAffineMatrix, kProjMatrix, kFile,   kUnknown }
enum	Property { kIsModified, kIsNotSaved, kIsDisabled }
Public Member Functions
	Parameter ()
virtual ParameterRef	clone () const =0
template<class T >
aw::Reference< T >	as ()
template<class T >
aw::Reference< const T >	as () const
virtual Parameter::Type	getType () const =0
virtual const awString::IString &	getName () const =0
virtual double	getValueAsDouble (int index, bool &ok) const =0
	Return the value at the given index as a double if: 1) the given index is valid for the Parameter::Type.
double	getValueAsDoubleWithDefault (int index, double defaultValue) const
	Same as getValueAsDoubleWithDefault( index, ok ), but returns the defaultValue if retrival was not ok.
virtual bool	setValueAsDouble (int index, double value)=0
	Sets the specified double inside the ValueParameter's value.
virtual bool	operator== (const Parameter &parameter) const =0
bool	operator!= (const Parameter &parameter) const
virtual bool	getValueAsAffineMatrix (awLinear::AffineMatrix &) const =0
	A few convenience methods for setting all values when dealing with the affine matrix case.
virtual bool	setValueAsAffineMatrix (const awLinear::AffineMatrix &)=0
virtual bool	getValueAsProjMatrix (awLinear::ProjMatrix &) const =0
virtual bool	setValueAsProjMatrix (const awLinear::ProjMatrix &)=0
virtual bool	checkConnectAssetValid ()=0
const awString::IString &	getValueAsString () const
virtual bool	setValueAsString (const awString::IString &value)=0
Static Public Member Functions
static const awString::IString	getTypeAsString (const Parameter::Type &type)
static const Parameter::Type	getTypeFromString (const awString::IString &stringType)
static void	parseFilenames (const awString::IString &stringToParse, awString::IString &filename1, awString::IString &filename2)
	Parses the given string delimited by this separator into its two parts.
Protected Member Functions
	Parameter (const Parameter &src)
virtual	~Parameter ()
virtual void	recomputeValueAsString () const =0
Protected Attributes
awString::IString	myValueAsString
bool	myValueAsStringValid

---

Member Enumeration Documentation

enum Type

Search for all occurrences

Enumerator:

kString	Search for all occurrences
kDouble	Search for all occurrences
kDouble2	Search for all occurrences
kDouble3	Search for all occurrences
kDouble4	Search for all occurrences
kAffineMatrix	Search for all occurrences
kProjMatrix	Search for all occurrences
kFile	Search for all occurrences
kUnknown	Search for all occurrences

                  {
            kString,
            kDouble,
            kDouble2,
            kDouble3,
            kDouble4,
            kAffineMatrix,
            kProjMatrix,
            kFile,          // Underlying representation is a string
            kUnknown
        };

enum Property

Search for all occurrences

Enumerator:

kIsModified	Search for all occurrences
kIsNotSaved	Search for all occurrences
kIsDisabled	Search for all occurrences

        {
            kIsModified,
            kIsNotSaved,
            kIsDisabled
        };

---

Constructor & Destructor Documentation

Parameter

(

)

Parameter

(

const Parameter &

src

)

[protected]

virtual ~Parameter

(

)

[protected, virtual]

---

Member Function Documentation

virtual ParameterRef clone

(

)

const [pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

aw::Reference< T > as

(

)

Search for all occurrences

{
    return dynamic_cast<T *>( this );
}

aw::Reference< const T > as

(

)

const

Search for all occurrences

{
    return dynamic_cast<const T *>( this );
}

virtual Parameter::Type getType

(

)

const [pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

static const awString::IString getTypeAsString

(

const Parameter::Type &

type

)

[static]

Search for all occurrences

static const Parameter::Type getTypeFromString

(

const awString::IString &

stringType

)

[static]

Search for all occurrences

virtual const awString::IString& getName

(

)

const [pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

const awString::IString& getValueAsString

(

)

const

Search for all occurrences

Access the parameter's value. It does not matter whether the Parameter is of type string or not -- you can always read/write it's string representation through getValueAsString and setValueAsString.

virtual bool setValueAsString

(

const awString::IString &

value

)

[pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

virtual double getValueAsDouble	(	int	index,
		bool &	ok
	)		const [pure virtual]

Search for all occurrences

Return the value at the given index as a double if: 1) the given index is valid for the Parameter::Type.

and 2) the value at the given index is valid. Otherwise, return 0 and set the boolean to false.

Implemented in ProteinParameter, and ValueParameter.

double getValueAsDoubleWithDefault	(	int	index,
		double	defaultValue
	)		const

Search for all occurrences

Same as getValueAsDoubleWithDefault( index, ok ), but returns the defaultValue if retrival was not ok.

virtual bool setValueAsDouble	(	int	index,
		double	value
	)		[pure virtual]

Search for all occurrences

Sets the specified double inside the ValueParameter's value.

Note that this will affect the result of getValueAsString Returns false if the parameter is not of the right type or if it's not mutable and the parameter will remain unmodified.

Implemented in ProteinParameter, and ValueParameter.

virtual bool operator==

(

const Parameter &

parameter

)

const [pure virtual]

Implemented in ProteinParameter, and ValueParameter.

bool operator!=

(

const Parameter &

parameter

)

const

virtual bool getValueAsAffineMatrix

(

awLinear::AffineMatrix &

)

const [pure virtual]

Search for all occurrences

A few convenience methods for setting all values when dealing with the affine matrix case.

Implemented in ProteinParameter, and ValueParameter.

virtual bool setValueAsAffineMatrix

(

const awLinear::AffineMatrix &

)

[pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

virtual bool getValueAsProjMatrix

(

awLinear::ProjMatrix &

)

const [pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

virtual bool setValueAsProjMatrix

(

const awLinear::ProjMatrix &

)

[pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

static void parseFilenames	(	const awString::IString &	stringToParse,
		awString::IString &	filename1,
		awString::IString &	filename2
	)		[static]

Search for all occurrences

Parses the given string delimited by this separator into its two parts.

virtual bool checkConnectAssetValid

(

)

[pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

virtual void recomputeValueAsString

(

)

const [protected, pure virtual]

Search for all occurrences

Implemented in ProteinParameter, and ValueParameter.

---

Member Data Documentation

awString::IString myValueAsString [mutable, protected]

Search for all occurrences

bool myValueAsStringValid [mutable, protected]

Search for all occurrences