![]() |
Eclipse 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 double | getFloat () const |
Returns the stored double 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 StringVector & | getStringVector () const |
Returns the stored string vector. More... | |
virtual const std::string & | getTypeName () const |
Returns the mml-type name of this option. More... | |
const 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_String () | |
Constructor for an option with no default value. More... | |
Option_String (const std::string &value, std::string typeName="STR") | |
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, const std::string &orig, const bool append) |
Stores the given value. More... | |
void | setDescription (const std::string &desc) |
Sets the description of what this option does. More... | |
Protected Member Functions | |
bool | markSet (const std::string &orig) |
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 |
std::string | myValueString |
The original set string. 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... | |
Option_String::Option_String | ( | ) |
Constructor for an option with no default value.
Calls Option(false)
Definition at line 187 of file Option.cpp.
References Option::myTypeName.
Option_String::Option_String | ( | const std::string & | value, |
std::string | typeName = "STR" |
||
) |
Constructor for an option with a default value.
Calls Option(true)
[in] | value | This option's default value |
Definition at line 193 of file Option.cpp.
References Option::myTypeName, and Option::myValueString.
|
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 74 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 139 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::getDescription(), OptionsCont::printHelpOnTopic(), and OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the stored double 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 56 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 62 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 80 of file Option.cpp.
Referenced by OptionsCont::getIntVector().
|
virtual |
Returns the stored string value.
Reimplemented from Option.
Definition at line 201 of file Option.cpp.
References myValue.
|
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.
InvalidArgument | If the class is not an instance of Option_StringVector |
Reimplemented in Option_StringVector.
Definition at line 86 of file Option.cpp.
Referenced by OptionsCont::getStringVector().
|
virtualinherited |
Returns the mml-type name of this option.
The type name stored in myTypeName is returned.
Definition at line 151 of file Option.cpp.
References Option::myTypeName.
Referenced by OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().
|
inlineinherited |
Returns the string-representation of the value.
The stored value is encoded into a string and returned.
Definition at line 167 of file Option.h.
References Option::myValueString.
Referenced by OptionsCont::getValueString(), Option_StringVector::set(), and OptionsCont::writeConfiguration().
|
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 103 of file Option.cpp.
Referenced by OptionsCont::isBool(), OptionsCont::printHelp(), and OptionsCont::printHelpOnTopic().
|
virtualinherited |
Returns the information whether the option holds the default value.
Definition at line 109 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 115 of file Option.cpp.
Referenced by OptionsCont::writeConfiguration().
|
inherited |
returns the information whether this options holds a valid value
Definition at line 50 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 121 of file Option.cpp.
References Option::myAmWritable.
Referenced by OptionsCont::isWriteable(), OptionsCont::set(), and OptionsCont::setDefault().
|
protectedinherited |
Marks the information as set.
Sets the "myAmSet" - information. Returns whether the option was writeable before.
Definition at line 92 of file Option.cpp.
References Option::myAmSet, Option::myAmWritable, Option::myHaveTheDefaultValue, and Option::myValueString.
Referenced by Option_Integer::set(), set(), Option_Float::set(), Option_Bool::set(), Option_BoolExtended::set(), Option_IntVector::set(), and Option_StringVector::set().
|
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 133 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 127 of file Option.cpp.
References Option::myAmWritable.
|
virtual |
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 207 of file Option.cpp.
References Option::markSet(), and myValue.
|
inherited |
Sets the description of what this option does.
The description stored in myDescription is returned.
Definition at line 145 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::addDescription().
|
privateinherited |
information whether the value is set
Definition at line 268 of file Option.h.
Referenced by Option::isSet(), and Option::markSet().
|
privateinherited |
information whether the value may be changed
Definition at line 274 of file Option.h.
Referenced by Option::isWriteable(), Option::markSet(), and Option::resetWritable().
|
privateinherited |
The description what this option does.
Definition at line 277 of file Option.h.
Referenced by Option::getDescription(), and Option::setDescription().
|
privateinherited |
information whether the value is the default value (is then set)
Definition at line 271 of file Option.h.
Referenced by Option::isDefault(), Option::markSet(), and Option::resetDefault().
|
protectedinherited |
A type name for this option (has presets, but may be overwritten)
Definition at line 261 of file Option.h.
Referenced by Option::getTypeName(), Option_Bool::Option_Bool(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), Option_String(), and Option_StringVector::Option_StringVector().
|
protected |
the value, valid only when the base-classes "myAmSet"-member is true
Definition at line 368 of file Option.h.
Referenced by getString(), and set().
|
protectedinherited |
The original set string.
Definition at line 264 of file Option.h.
Referenced by Option::getValueString(), Option::markSet(), Option_Bool::Option_Bool(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), Option_String(), and Option_StringVector::Option_StringVector().