Thea
Public Member Functions | List of all members
IOptions Class Referenceabstract

Interface for key-value options, suitable for passing across DLL boundaries. More...

#include <Options.hpp>

Inheritance diagram for IOptions:
Options

Public Member Functions

virtual float64 getFloat (char const *option_name, float64 default_value) const =0
 Get the value of a floating-point option. More...
 
virtual int64 getInteger (char const *option_name, int64 default_value) const =0
 Get the value of an integer option. More...
 
virtual char const * getString (char const *option_name, char const *default_value) const =0
 Get the value of a string option. More...
 
virtual int8 hasOption (char const *option_name) const =0
 Check if an option has been set. More...
 
virtual void setFloat (char const *option_name, float64 value)=0
 Set the value of a floating-point option. More...
 
virtual void setInteger (char const *option_name, int64 value)=0
 Set the value of an integer option. More...
 
virtual void setString (char const *option_name, char const *value)=0
 Set the value of a string option. More...
 
virtual ~IOptions ()
 Destructor. More...
 

Detailed Description

Interface for key-value options, suitable for passing across DLL boundaries.

Definition at line 25 of file Options.hpp.

Constructor & Destructor Documentation

virtual ~IOptions ( )
virtual

Destructor.

Definition at line 29 of file Options.hpp.

Member Function Documentation

virtual float64 getFloat ( char const *  option_name,
float64  default_value 
) const
pure virtual

Get the value of a floating-point option.

If the option has not been set, the default value specified by the last parameter is returned.

Implemented in Options.

virtual int64 getInteger ( char const *  option_name,
int64  default_value 
) const
pure virtual

Get the value of an integer option.

If the option has not been set, the default value specified by the last parameter is returned.

Implemented in Options.

virtual char const* getString ( char const *  option_name,
char const *  default_value 
) const
pure virtual

Get the value of a string option.

If the option has not been set, the default value specified by the last parameter is returned.

Implemented in Options.

virtual int8 hasOption ( char const *  option_name) const
pure virtual

Check if an option has been set.

Implemented in Options.

virtual void setFloat ( char const *  option_name,
float64  value 
)
pure virtual

Set the value of a floating-point option.

Implemented in Options.

virtual void setInteger ( char const *  option_name,
int64  value 
)
pure virtual

Set the value of an integer option.

Implemented in Options.

virtual void setString ( char const *  option_name,
char const *  value 
)
pure virtual

Set the value of a string option.

Implemented in Options.


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