SUMO - Simulation of Urban MObility
|
#include <Option.h>
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... | |
SUMOReal | getFloat () const |
Returns the stored SUMOReal value. More... | |
virtual int | getInt () const |
Returns the stored integer value. More... | |
virtual const IntVector & | getIntVector () const |
Returns the stored integer vector. More... | |
virtual std::string | getString () const |
Returns the stored string value. 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_Float & | operator= (const Option_Float &s) |
Assignment operator. More... | |
Option_Float () | |
Constructor for an option with no default value. More... | |
Option_Float (SUMOReal value) | |
Constructor for an option with a default value. More... | |
Option_Float (const Option_Float &s) | |
Copy constructor. 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 SUMOReal. 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... | |
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 | |
SUMOReal | myValue |
Option_Float::Option_Float | ( | ) |
Constructor for an option with no default value.
Calls Option(false)
Definition at line 301 of file Option.cpp.
References Option::myTypeName.
Option_Float::Option_Float | ( | SUMOReal | value | ) |
Constructor for an option with a default value.
Calls Option(true)
[in] | value | This option's default value |
Definition at line 307 of file Option.cpp.
References Option::myTypeName.
Option_Float::Option_Float | ( | const Option_Float & | s | ) |
Option_Float::~Option_Float | ( | ) |
Destructor.
Definition at line 313 of file Option.cpp.
|
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.
InvalidArgument | If the class is not an instance of Option_Bool |
Reimplemented in Option_Bool.
Definition at line 103 of file Option.cpp.
Referenced by OptionsCont::getBool().
|
inherited |
Returns the description of what this option does.
The description stored in myDescription is returned.
Definition at line 162 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::printHelp(), and OptionsCont::writeConfiguration().
|
virtual |
Returns the stored SUMOReal value.
Reimplemented from Option.
Definition at line 334 of file Option.cpp.
References myValue.
|
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.
InvalidArgument | If the class is not an instance of Option_Integer |
Reimplemented in Option_Integer.
Definition at line 91 of file Option.cpp.
Referenced by OptionsCont::getInt().
|
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.
InvalidArgument | If the class is not an instance of Option_IntVector |
Reimplemented in Option_IntVector.
Definition at line 109 of file Option.cpp.
Referenced by OptionsCont::getIntVector().
|
virtualinherited |
Returns the stored string value.
Option_String and Option_FileName return the stored string in this method's reimplementation. All other option classes do not override this method which throws an InvalidArgument-exception.
InvalidArgument | If the class is not an instance of Option_String |
Reimplemented in Option_String.
Definition at line 97 of file Option.cpp.
Referenced by OptionsCont::getString(), and OptionsCont::getStringVector().
|
virtualinherited |
Returns the mml-type name of this option.
The type name stored in myTypeName is returned.
Definition at line 174 of file Option.cpp.
References Option::myTypeName.
Referenced by OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().
|
virtual |
Returns the string-representation of the value.
The stored value is encoded into a string and returned.
Implements Option.
Definition at line 351 of file Option.cpp.
References myValue.
|
virtualinherited |
Returns the information whether the option is a bool option.
Returns false. Only Option_Bool overrides this method returning true.
Reimplemented in Option_Bool.
Definition at line 132 of file Option.cpp.
Referenced by OptionsCont::isBool(), and OptionsCont::printHelp().
|
virtualinherited |
Returns the information whether the option holds the default value.
Definition at line 138 of file Option.cpp.
References Option::myHaveTheDefaultValue.
Referenced by OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the information whether this option is a file name.
Returns false. Only Option_FileName overrides this method returning true.
Reimplemented in Option_FileName.
Definition at line 144 of file Option.cpp.
|
inherited |
returns the information whether this options holds a valid value
Definition at line 79 of file Option.cpp.
References Option::myAmSet.
Referenced by OptionsCont::checkDependingSuboptions(), OptionsCont::isUsableFileList(), and OptionsCont::writeConfiguration().
|
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.
Definition at line 150 of file Option.cpp.
References Option::myAmWritable.
Referenced by OptionsCont::isWriteable(), and OptionsCont::set().
|
protectedinherited |
Marks the information as set.
Sets the "myAmSet" - information. Returns whether the option was writeable before.
Definition at line 115 of file Option.cpp.
References Option::myAmSet, Option::myAmWritable, and Option::myHaveTheDefaultValue.
Referenced by Option_Integer::set(), Option_String::set(), set(), Option_Bool::set(), and Option_IntVector::set().
Option_Float & Option_Float::operator= | ( | const Option_Float & | s | ) |
Assignment operator.
Definition at line 323 of file Option.cpp.
References myValue, and Option::operator=().
|
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 156 of file Option.cpp.
References Option::myAmWritable.
|
virtual |
Stores the given value after parsing it into a SUMOReal.
The value is converted into a SUMOReal 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 SUMOReal, an InvalidArgument is thrown.
InvalidArgument | If the value could not be converted into a SUMOReal |
Implements Option.
Definition at line 340 of file Option.cpp.
References TplConvert::_2SUMOReal(), Option::markSet(), and myValue.
|
inherited |
Sets the description of what this option does.
The description stored in myDescription is returned.
Definition at line 168 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::addDescription().
|
inherited |
marks this option as unset
Definition at line 125 of file Option.cpp.
References Option::myAmSet, and Option::myAmWritable.
|
protectedinherited |
A type name for this option (has presets, but may be overwritten)
Definition at line 282 of file Option.h.
Referenced by Option::getTypeName(), Option_Bool::Option_Bool(), Option_FileName::Option_FileName(), Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), and Option_String::Option_String().
|
private |
the value, valid only when the base-classes "myAmSet"-member is true
Definition at line 521 of file Option.h.
Referenced by getFloat(), getValueString(), operator=(), Option_Float(), and set().