Eclipse SUMO - Simulation of Urban MObility
Option_Float Class Reference

#include <Option.h>

Inheritance diagram for Option_Float:
[legend]
Collaboration diagram for Option_Float:
[legend]

Public Member Functions

virtual bool getBool () const
 Returns the stored boolean value. More...
 
const std::string & getDescription () const
 Returns the description of what this option does. More...
 
double getFloat () const
 Returns the stored double value. More...
 
virtual int getInt () const
 Returns the stored integer value. More...
 
virtual const IntVectorgetIntVector () const
 Returns the stored integer vector. More...
 
virtual std::string getString () const
 Returns the stored string value. More...
 
virtual const StringVectorgetStringVector () const
 Returns the stored string vector. More...
 
virtual const std::string & getTypeName () const
 Returns the mml-type name of this option. More...
 
std::string getValueString () const
 Returns the string-representation of the value. More...
 
virtual bool isBool () const
 Returns the information whether the option is a bool option. More...
 
virtual bool isDefault () const
 Returns the information whether the option holds the default value. More...
 
virtual bool isFileName () const
 Returns the information whether this option is a file name. More...
 
bool isSet () const
 returns the information whether this options holds a valid value More...
 
bool isWriteable () const
 Returns the information whether the option may be set a further time. More...
 
Option_Floatoperator= (const Option_Float &s)
 Assignment operator. More...
 
 Option_Float (const Option_Float &s)
 Copy constructor. More...
 
 Option_Float (double value)
 Constructor for an option with a default value. More...
 
void resetDefault ()
 Resets the option to be on its default value. More...
 
void resetWritable ()
 Resets the option to be writeable. More...
 
bool set (const std::string &v)
 Stores the given value after parsing it into a double. More...
 
void setDescription (const std::string &desc)
 Sets the description of what this option does. More...
 
void unSet ()
 marks this option as unset More...
 
 ~Option_Float ()
 Destructor. More...
 

Static Public Member Functions

template<class OptionType , class ValueType >
static OptionType * makeUnsetWithDefault (ValueType def)
 Create a new Option of the given type with given default value but make it unset. More...
 

Protected Member Functions

bool markSet ()
 Marks the information as set. More...
 

Protected Attributes

std::string myTypeName
 A type name for this option (has presets, but may be overwritten) More...
 

Private Attributes

bool myAmSet
 information whether the value is set More...
 
bool myAmWritable
 information whether the value may be changed More...
 
std::string myDescription
 The description what this option does. More...
 
bool myHaveTheDefaultValue
 information whether the value is the default value (is then set) More...
 
double myValue
 

Detailed Description

Definition at line 468 of file Option.h.

Constructor & Destructor Documentation

◆ Option_Float() [1/2]

Option_Float::Option_Float ( double  value)

Constructor for an option with a default value.

Calls Option(true)

Parameters
[in]valueThis option's default value

Definition at line 293 of file Option.cpp.

References Option::myTypeName.

◆ Option_Float() [2/2]

Option_Float::Option_Float ( const Option_Float s)

Copy constructor.

Definition at line 302 of file Option.cpp.

References myValue.

◆ ~Option_Float()

Option_Float::~Option_Float ( )

Destructor.

Definition at line 299 of file Option.cpp.

Member Function Documentation

◆ getBool()

bool Option::getBool ( ) const
virtualinherited

Returns the stored boolean value.

Option_Bool returns the stored boolean in this method's reimplementation. All other option classes do not override this method which throws an InvalidArgument-exception.

Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgumentIf the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

Definition at line 91 of file Option.cpp.

Referenced by OptionsCont::getBool().

Here is the caller graph for this function:

◆ getDescription()

const std::string & Option::getDescription ( ) const
inherited

Returns the description of what this option does.

The description stored in myDescription is returned.

Returns
The description of this option's purpose

Definition at line 160 of file Option.cpp.

References Option::myDescription.

Referenced by OptionsCont::getDescription(), OptionsCont::printHelpOnTopic(), and OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ getFloat()

double Option_Float::getFloat ( ) const
virtual

Returns the stored double value.

See also
double Option::getFloat()
Returns
Returns the stored real number

Reimplemented from Option.

Definition at line 320 of file Option.cpp.

References myValue.

◆ getInt()

int Option::getInt ( ) const
virtualinherited

Returns the stored integer value.

Option_Integer returns the stored integer number in this method's reimplementation. All other option classesdo not override this method which throws an InvalidArgument-exception.

Returns
Returns the stored integer number if being an instance of Option_Integer
Exceptions
InvalidArgumentIf the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

Definition at line 79 of file Option.cpp.

Referenced by OptionsCont::getInt().

Here is the caller graph for this function:

◆ getIntVector()

const IntVector & Option::getIntVector ( ) const
virtualinherited

Returns the stored integer vector.

Option_IntVector returns the stored integer vector in this method's reimplementation. All other option classes do not override this method which throws an InvalidArgument-exception.

Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgumentIf the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

Definition at line 97 of file Option.cpp.

Referenced by OptionsCont::getIntVector().

Here is the caller graph for this function:

◆ getString()

std::string Option::getString ( ) const
virtualinherited

Returns the stored string value.

Option_String returns the stored string in this method's reimplementation. Option_FileName's reimplementation is only to be used for single filename string-vector options. All other option classes do not override this method which throws an InvalidArgument-exception.

Returns
Returns the stored string if being an instance of Option_String or Option_FileName
Exceptions
InvalidArgumentIf the class is not an instance of Option_String or Option_FileName

Reimplemented in Option_FileName, and Option_String.

Definition at line 85 of file Option.cpp.

Referenced by OptionsCont::getString().

Here is the caller graph for this function:

◆ getStringVector()

const StringVector & Option::getStringVector ( ) const
virtualinherited

Returns the stored string vector.

Option_StringVector returns the stored string vector in this method's reimplementation. All other option classes do not override this method which throws an InvalidArgument-exception.

Returns
Returns the stored string vector if being an instance of Option_StringVector
Exceptions
InvalidArgumentIf the class is not an instance of Option_StringVector

Reimplemented in Option_StringVector.

Definition at line 102 of file Option.cpp.

Referenced by OptionsCont::getStringVector().

Here is the caller graph for this function:

◆ getTypeName()

const std::string & Option::getTypeName ( ) const
virtualinherited

Returns the mml-type name of this option.

The type name stored in myTypeName is returned.

Returns
The man-readable type name

Definition at line 172 of file Option.cpp.

References Option::myTypeName.

Referenced by OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().

Here is the caller graph for this function:

◆ getValueString()

std::string Option_Float::getValueString ( ) const
virtual

Returns the string-representation of the value.

The stored value is encoded into a string and returned.

See also
std::string Option::getValueString()
Returns
The stored value encoded into a string

Implements Option.

Definition at line 337 of file Option.cpp.

References myValue.

◆ isBool()

bool Option::isBool ( ) const
virtualinherited

Returns the information whether the option is a bool option.

Returns false. Only Option_Bool overrides this method returning true.

Returns
true if the Option is an Option_Bool, false otherwise

Reimplemented in Option_Bool.

Definition at line 124 of file Option.cpp.

Referenced by OptionsCont::isBool(), OptionsCont::printHelp(), and OptionsCont::printHelpOnTopic().

Here is the caller graph for this function:

◆ isDefault()

bool Option::isDefault ( ) const
virtualinherited

Returns the information whether the option holds the default value.

Returns
true if the option was not set from command line / configuration, false otherwise

Definition at line 130 of file Option.cpp.

References Option::myHaveTheDefaultValue.

Referenced by OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isFileName()

bool Option::isFileName ( ) const
virtualinherited

Returns the information whether this option is a file name.

Returns false. Only Option_FileName overrides this method returning true.

Returns
true if the Option is an Option_FileName, false otherwise

Reimplemented in Option_FileName.

Definition at line 136 of file Option.cpp.

◆ isSet()

bool Option::isSet ( ) const
inherited

returns the information whether this options holds a valid value

Returns
Whether a value has been set

Definition at line 67 of file Option.cpp.

References Option::myAmSet.

Referenced by OptionsCont::checkDependingSuboptions(), OptionsCont::isUsableFileList(), and OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isWriteable()

bool Option::isWriteable ( ) const
inherited

Returns the information whether the option may be set a further time.

This method returns whether the option was not already set using command line options / configuration. This is done by returning the value of myAmWritable.

Returns
Whether the option may be set from the command line / configuration

Definition at line 142 of file Option.cpp.

References Option::myAmWritable.

Referenced by OptionsCont::isWriteable(), and OptionsCont::set().

Here is the caller graph for this function:

◆ makeUnsetWithDefault()

template<class OptionType , class ValueType >
static OptionType* Option::makeUnsetWithDefault ( ValueType  def)
inlinestaticinherited

Create a new Option of the given type with given default value but make it unset.

Note
Was implemented to allow warning once if user didn't set the option, refs. #4567
See also
MSDeviceSSM::insertOptions()

Definition at line 265 of file Option.h.

◆ markSet()

bool Option::markSet ( )
protectedinherited

Marks the information as set.

Sets the "myAmSet" - information. Returns whether the option was writeable before.

Returns
Whether the option was not set before.

Definition at line 107 of file Option.cpp.

References Option::myAmSet, Option::myAmWritable, and Option::myHaveTheDefaultValue.

Referenced by Option_Integer::set(), Option_String::set(), set(), Option_Bool::set(), Option_BoolExtended::set(), Option_IntVector::set(), and Option_StringVector::set().

Here is the caller graph for this function:

◆ operator=()

Option_Float & Option_Float::operator= ( const Option_Float s)

Assignment operator.

Definition at line 309 of file Option.cpp.

References myValue, and Option::operator=().

◆ resetDefault()

void Option::resetDefault ( )
inherited

Resets the option to be on its default value.

An option is on its default after initialisation with a value, but as soon as it gets set, it is no longer. This method resets the default-flag.

Definition at line 154 of file Option.cpp.

References Option::myHaveTheDefaultValue.

Referenced by OptionsCont::setDefault().

Here is the caller graph for this function:

◆ resetWritable()

void Option::resetWritable ( )
inherited

Resets the option to be writeable.

An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the writable-flag.

Definition at line 148 of file Option.cpp.

References Option::myAmWritable.

◆ set()

bool Option_Float::set ( const std::string &  v)
virtual

Stores the given value after parsing it into a double.

The value is converted into a double and stored in "myValue". Then, "markSet" is called in order to know that a value has been set.

The method returns whether the value could be set (the return value from "markSet").

If the string could not be converted into a double, an InvalidArgument is thrown.

See also
bool Option::set(std::string v)
Returns
Whether the new value could be set
Exceptions
InvalidArgumentIf the value could not be converted into a double

Implements Option.

Definition at line 326 of file Option.cpp.

References Option::markSet(), myValue, and StringUtils::toDouble().

◆ setDescription()

void Option::setDescription ( const std::string &  desc)
inherited

Sets the description of what this option does.

The description stored in myDescription is returned.

Returns
The description of this option's purpose

Definition at line 166 of file Option.cpp.

References Option::myDescription.

Referenced by OptionsCont::addDescription().

Here is the caller graph for this function:

◆ unSet()

void Option::unSet ( )
inherited

marks this option as unset

Definition at line 117 of file Option.cpp.

References Option::myAmSet, and Option::myAmWritable.

Field Documentation

◆ myAmSet

bool Option::myAmSet
privateinherited

information whether the value is set

Definition at line 308 of file Option.h.

Referenced by Option::isSet(), Option::markSet(), Option::operator=(), and Option::unSet().

◆ myAmWritable

bool Option::myAmWritable
privateinherited

information whether the value may be changed

Definition at line 314 of file Option.h.

Referenced by Option::isWriteable(), Option::markSet(), Option::operator=(), Option::resetWritable(), and Option::unSet().

◆ myDescription

std::string Option::myDescription
privateinherited

The description what this option does.

Definition at line 317 of file Option.h.

Referenced by Option::getDescription(), and Option::setDescription().

◆ myHaveTheDefaultValue

bool Option::myHaveTheDefaultValue
privateinherited

information whether the value is the default value (is then set)

Definition at line 311 of file Option.h.

Referenced by Option::isDefault(), Option::markSet(), Option::operator=(), and Option::resetDefault().

◆ myTypeName

std::string Option::myTypeName
protectedinherited

◆ myValue

double Option_Float::myValue
private

the value, valid only when the base-classes "myAmSet"-member is true

Definition at line 528 of file Option.h.

Referenced by getFloat(), getValueString(), operator=(), Option_Float(), and set().


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