DriveEngine::DefaultRealNumberParameter Class Reference

Inheritance diagram for DriveEngine::DefaultRealNumberParameter:

Public Member Functions
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter)
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter, const char *name)
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter, const char *name, double initialValue)
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter, const char *name, long double minValue, long double maxValue)
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter, const char *name, double initialValue, long double minValue, long double maxValue)
	CONSTRUCTOR_H (IRealNumberParameter, DefaultRealNumberParameter, long double minValue, long double maxValue)
	DESTRUCTOR_H (DefaultRealNumberParameter)
virtual void	SetName (const char *name)
	Sets the name of the parameter. More...
virtual const char *	GetName () const
	Gets the name of the parameter. More...
virtual const char *	GetType () const
	Gets the type of the parameter. More...
virtual void	SetValueByString (const char *value)
	Sets the value of the parameter by a string. More...
virtual const char *	GetValueByString ()
	Gets the value of the parameter by a string. More...
virtual void	SetValue (long double value)
	Sets the parameter value. More...
virtual double	GetValue () const
	Gets the parameter value. More...
Public Member Functions inherited from IExportable
virtual void	Delete () const =0
	Deletes the current object. Needed for memory management. More...

Member Function Documentation

virtual const char* DriveEngine::DefaultRealNumberParameter::GetName ( ) const

virtual

Gets the name of the parameter.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

The parameter name.

Implements DriveEngine::IParameter.

virtual const char* DriveEngine::DefaultRealNumberParameter::GetType ( ) const

virtual

Gets the type of the parameter.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

Returns the type.

Implements DriveEngine::IParameter.

virtual double DriveEngine::DefaultRealNumberParameter::GetValue ( ) const

virtual

Gets the parameter value.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

The real number parameter value.

Implements DriveEngine::IRealNumberParameter.

virtual const char* DriveEngine::DefaultRealNumberParameter::GetValueByString ( )

virtual

Gets the value of the parameter by a string.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns

Returns the value by string. If no value was set it returns an empty string

Implements DriveEngine::IParameter.

virtual void DriveEngine::DefaultRealNumberParameter::SetName ( const char *  name )

virtual

Sets the name of the parameter.

If the text is null or empty, the name will be an empty string.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

name	The parameter name.

Implements DriveEngine::IParameter.

virtual void DriveEngine::DefaultRealNumberParameter::SetValue ( long double  number )

virtual

Sets the parameter value.

If the number is null, the parameter value will be zero.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Parameters

number

The new real number parameter value.

Implements DriveEngine::IRealNumberParameter.

virtual void DriveEngine::DefaultRealNumberParameter::SetValueByString ( const char *  value )

virtual

Sets the value of the parameter by a string.

A string type value will be converted in a concret value in function of the type of parameter.

Exception safety : Strong exception safety. This member function throws exceptions if the argument cannot be converted to a valid value of the parameter.

Parameters

value

The parameter name.

Implements DriveEngine::IParameter.

---

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

• Framework/Private/Datatypes/DefaultImplementations/DefaultRealNumberParameter.h