DriveEngine::DefaultTextParameter Class Reference

Inheritance diagram for DriveEngine::DefaultTextParameter:

Public Member Functions
	CONSTRUCTOR_H (ITextParameter, DefaultTextParameter)
	DESTRUCTOR_H (DefaultTextParameter)
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 (const char *value)
	Sets the parameter value. More...
virtual const char *	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

const char * DefaultTextParameter::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.

const char * DefaultTextParameter::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.

const char * DefaultTextParameter::GetValue ( ) const

virtual

Gets the parameter value.

The value is garanteed to be a valid string.

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

Returns

The text parameter value.

Implements DriveEngine::ITextParameter.

const char * DefaultTextParameter::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.

void DefaultTextParameter::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.

void DefaultTextParameter::SetValue ( const char *  text )

virtual

Sets the parameter value.

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

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

Parameters

text	The new text parameter value.

Implements DriveEngine::ITextParameter.

void DefaultTextParameter::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 files:

• Framework/Private/Datatypes/DefaultImplementations/DefaultTextParameter.h
• Framework/Private/Datatypes/DefaultImplementations/DefaultTextParameter.cpp