![]() |
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... | |
virtual 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... | |
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... | |
bool | isFileName () const |
Returns true, 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_FileName & | operator= (const Option_FileName &s) |
Assignment operator. More... | |
Option_FileName () | |
Constructor for an option with no default value. More... | |
Option_FileName (const std::string &value) | |
Constructor for an option with a default value. More... | |
Option_FileName (const Option_String &s) | |
Copy constructor. 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. More... | |
void | setDescription (const std::string &desc) |
Sets the description of what this option does. More... | |
void | unSet () |
marks this option as unset More... | |
virtual | ~Option_FileName () |
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... | |
std::string | myValue |
Option_FileName::Option_FileName | ( | ) |
Constructor for an option with no default value.
Definition at line 419 of file Option.cpp.
References Option::myTypeName.
Option_FileName::Option_FileName | ( | const std::string & | value | ) |
Constructor for an option with a default value.
[in] | value | This option's default value |
Definition at line 425 of file Option.cpp.
References Option::myTypeName.
Option_FileName::Option_FileName | ( | const Option_String & | s | ) |
Copy constructor.
Definition at line 431 of file Option.cpp.
|
virtual |
Destructor.
Definition at line 435 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 104 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 169 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::printHelp(), and OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the stored SUMOReal value.
Option_Float returns the stored real number 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_Float |
Reimplemented in Option_Float.
Definition at line 86 of file Option.cpp.
Referenced by OptionsCont::getFloat().
|
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 92 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 110 of file Option.cpp.
Referenced by OptionsCont::getIntVector().
|
virtualinherited |
Returns the stored string value.
Reimplemented from Option.
Definition at line 280 of file Option.cpp.
References Option_String::myValue.
|
virtualinherited |
Returns the mml-type name of this option.
The type name stored in myTypeName is returned.
Definition at line 181 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 value is URL-encoded using StringUtils::urlEncode and returned.
Reimplemented from Option_String.
Definition at line 452 of file Option.cpp.
References Option_String::myValue, and StringUtils::urlEncode().
|
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 133 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 139 of file Option.cpp.
References Option::myHaveTheDefaultValue.
Referenced by OptionsCont::writeConfiguration().
|
virtual |
Returns true, the information whether this option is a file name.
Returns true.
Reimplemented from Option.
Definition at line 446 of file Option.cpp.
|
inherited |
returns the information whether this options holds a valid value
Definition at line 80 of file Option.cpp.
References Option::myAmSet, and SUMOReal.
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 151 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 116 of file Option.cpp.
References Option::myAmSet, Option::myAmWritable, and Option::myHaveTheDefaultValue.
Referenced by Option_Integer::set(), Option_String::set(), Option_Float::set(), Option_Bool::set(), and Option_IntVector::set().
Option_FileName & Option_FileName::operator= | ( | const Option_FileName & | s | ) |
Assignment operator.
Definition at line 439 of file Option.cpp.
References Option_String::operator=().
|
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 163 of file Option.cpp.
References Option::myHaveTheDefaultValue.
Referenced by OptionsCont::setDefault().
|
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 157 of file Option.cpp.
References Option::myAmWritable.
|
virtualinherited |
Stores the given value.
The value is 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").
Implements Option.
Definition at line 286 of file Option.cpp.
References Option::markSet(), and Option_String::myValue.
|
inherited |
Sets the description of what this option does.
The description stored in myDescription is returned.
Definition at line 175 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::addDescription().
|
inherited |
marks this option as unset
Definition at line 126 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 287 of file Option.h.
Referenced by Option::getTypeName(), Option_Bool::Option_Bool(), Option_FileName(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), and Option_String::Option_String().
|
protectedinherited |
the value, valid only when the base-classes "myAmSet"-member is true
Definition at line 444 of file Option.h.
Referenced by Option_String::getString(), Option_String::getValueString(), getValueString(), Option_String::operator=(), Option_String::Option_String(), and Option_String::set().