Drive Engine  1.0.0
Plateforme de reconstruction 3D
Public Member Functions | List of all members
DriveEngine::IParameter Class Referenceabstract

The parameter datatype interface. More...

#include <IParameter.h>

Inheritance diagram for DriveEngine::IParameter:
DriveEngine::IDatatype IExportable DriveEngine::IIntegerNumberParameter DriveEngine::ILogicalParameter DriveEngine::IRealNumberParameter DriveEngine::ITextParameter DriveEngine::DefaultIntegerNumberParameter DriveEngine::DefaultLogicalParameter DriveEngine::DefaultRealNumberParameter DriveEngine::DefaultTextParameter

Public Member Functions

virtual void SetName (const char *name)=0
 Sets the name of the parameter. More...
 
virtual const char * GetName () const =0
 Gets the name of the parameter. More...
 
virtual const char * GetType () const =0
 Gets the type of the parameter. More...
 
virtual void SetValueByString (const char *value)=0
 Sets the value of the parameter by a string. More...
 
virtual const char * GetValueByString ()=0
 Gets the value of the parameter by a string. More...
 
- Public Member Functions inherited from IExportable
virtual void Delete () const =0
 Deletes the current object. Needed for memory management. More...
 

Detailed Description

The parameter datatype interface.

It minimally contain a name and a value.

Member Function Documentation

virtual const char* DriveEngine::IParameter::GetName ( ) const
pure virtual

Gets the name of the parameter.

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

Returns
The parameter name.

Implemented in DriveEngine::DefaultIntegerNumberParameter, DriveEngine::DefaultRealNumberParameter, DriveEngine::DefaultLogicalParameter, and DriveEngine::DefaultTextParameter.

virtual const char* DriveEngine::IParameter::GetType ( ) const
pure virtual

Gets the type of the parameter.

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

Returns
Returns the type.

Implemented in DriveEngine::DefaultIntegerNumberParameter, DriveEngine::DefaultRealNumberParameter, DriveEngine::DefaultLogicalParameter, and DriveEngine::DefaultTextParameter.

virtual const char* DriveEngine::IParameter::GetValueByString ( )
pure 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

Implemented in DriveEngine::DefaultIntegerNumberParameter, DriveEngine::DefaultRealNumberParameter, DriveEngine::DefaultLogicalParameter, and DriveEngine::DefaultTextParameter.

virtual void DriveEngine::IParameter::SetName ( const char *  name)
pure 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
nameThe parameter name.

Implemented in DriveEngine::DefaultIntegerNumberParameter, DriveEngine::DefaultRealNumberParameter, DriveEngine::DefaultLogicalParameter, and DriveEngine::DefaultTextParameter.

virtual void DriveEngine::IParameter::SetValueByString ( const char *  value)
pure 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
valueThe parameter name.

Implemented in DriveEngine::DefaultIntegerNumberParameter, DriveEngine::DefaultRealNumberParameter, DriveEngine::DefaultLogicalParameter, and DriveEngine::DefaultTextParameter.

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