Drive Engine  1.0.0
Plateforme de reconstruction 3D
DriveEngine::ITextParameter Class Referenceabstract

The text parameter datatype interface. More...

#include <ITextParameter.h>

Inheritance diagram for DriveEngine::ITextParameter:
DriveEngine::IParameter DriveEngine::IDatatype IExportable DriveEngine::DefaultTextParameter

Public Member Functions

virtual void SetValue (const char *text)=0
 Sets the parameter value. More...
 
virtual const char * GetValue () const =0
 Gets the parameter value. More...
 
- Public Member Functions inherited from DriveEngine::IParameter
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 text parameter datatype interface.

It has a text as value.

Member Function Documentation

virtual const char* DriveEngine::ITextParameter::GetValue ( ) const
pure 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.

Implemented in DriveEngine::DefaultTextParameter.

virtual void DriveEngine::ITextParameter::SetValue ( const char *  text)
pure 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
textThe new text parameter value.

Implemented in DriveEngine::DefaultTextParameter.


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