![]() |
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... | |
const IntVector & | getIntVector () const |
Returns the stored integer vector. More... | |
virtual 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... | |
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_IntVector & | operator= (const Option_IntVector &s) |
Assignment operator. More... | |
Option_IntVector () | |
Constructor for an option with no default value. More... | |
Option_IntVector (const IntVector &value) | |
Constructor for an option with a default value. More... | |
Option_IntVector (const Option_IntVector &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 after parsing it into a vector of integers. 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_IntVector () |
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... | |
IntVector | myValue |
Option_IntVector::Option_IntVector | ( | ) |
Constructor for an option with no default value.
Definition at line 458 of file Option.cpp.
References Option::myTypeName.
Option_IntVector::Option_IntVector | ( | const IntVector & | value | ) |
Constructor for an option with a default value.
[in] | value | This option's default value |
Definition at line 464 of file Option.cpp.
References Option::myTypeName.
Option_IntVector::Option_IntVector | ( | const Option_IntVector & | s | ) |
Copy constructor.
Definition at line 470 of file Option.cpp.
|
virtual |
Destructor.
Definition at line 474 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 91 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 160 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 73 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 79 of file Option.cpp.
Referenced by OptionsCont::getInt().
|
virtual |
Returns the stored integer vector.
Reimplemented from Option.
Definition at line 486 of file Option.cpp.
References myValue.
|
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.
InvalidArgument | If 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().
|
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 102 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 172 of file Option.cpp.
References Option::myTypeName.
Referenced by OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), 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 512 of file Option.cpp.
References joinToString(), and 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 124 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 130 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 136 of file Option.cpp.
|
inherited |
returns the information whether this options holds a valid value
Definition at line 67 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 142 of file Option.cpp.
References Option::myAmWritable.
Referenced by OptionsCont::isWriteable(), and OptionsCont::set().
|
inlinestaticinherited |
|
protectedinherited |
Marks the information as set.
Sets the "myAmSet" - information. Returns whether the option was writeable 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(), Option_Float::set(), Option_Bool::set(), Option_BoolExtended::set(), set(), and Option_StringVector::set().
Option_IntVector & Option_IntVector::operator= | ( | const Option_IntVector & | s | ) |
Assignment operator.
Definition at line 478 of file Option.cpp.
References myValue, and Option::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 154 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 148 of file Option.cpp.
References Option::myAmWritable.
|
virtual |
Stores the given value after parsing it into a vector of integers.
The value is converted into a vector of integers 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 vector of integers, an InvalidArgument is thrown.
InvalidArgument | If the value could not be converted into a vector of integers |
Implements Option.
Definition at line 492 of file Option.cpp.
References StringTokenizer::hasNext(), Option::markSet(), myValue, StringTokenizer::next(), StringUtils::toInt(), and WRITE_WARNING.
|
inherited |
Sets the description of what this option does.
The description stored in myDescription is returned.
Definition at line 166 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::addDescription().
|
inherited |
marks this option as unset
Definition at line 117 of file Option.cpp.
References Option::myAmSet, and Option::myAmWritable.
|
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().
|
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().
|
privateinherited |
The description what this option does.
Definition at line 317 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 311 of file Option.h.
Referenced by Option::isDefault(), Option::markSet(), Option::operator=(), and Option::resetDefault().
|
protectedinherited |
A type name for this option (has presets, but may be overwritten)
Definition at line 303 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_String::Option_String(), and Option_StringVector::Option_StringVector().
|
private |
the value, valid only when the base-classes "myAmSet"-member is true
Definition at line 711 of file Option.h.
Referenced by getIntVector(), getValueString(), operator=(), and set().