![]() |
Eclipse SUMO - Simulation of Urban MObility
|
An integer-option. More...
#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 const FloatVector & | getFloatVector () const |
Returns the stored float vector. More... | |
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_Integer & | operator= (const Option_Integer &s) |
Assignment operator. More... | |
Option_Integer (int value) | |
Constructor for an option with a default value. More... | |
Option_Integer (const Option_Integer &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 an integer. 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_Integer () | |
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 | |
int | myValue |
Option_Integer::Option_Integer | ( | int | value | ) |
Constructor for an option with a default value.
Calls Option(true)
[in] | value | This option's default value |
Definition at line 184 of file Option.cpp.
References Option::myTypeName.
Option_Integer::Option_Integer | ( | const Option_Integer & | s | ) |
Option_Integer::~Option_Integer | ( | ) |
Destructor.
Definition at line 190 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 93 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::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 75 of file Option.cpp.
Referenced by OptionsCont::getFloat().
|
virtualinherited |
Returns the stored float vector.
Option_FloatVector returns the stored float 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_FloatVector |
Reimplemented in Option_FloatVector.
Definition at line 104 of file Option.cpp.
Referenced by OptionsCont::getFloatVector().
|
virtual |
Returns the stored integer value.
Reimplemented from Option.
Definition at line 211 of file Option.cpp.
References myValue.
|
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 99 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 87 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::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 229 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 126 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 132 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 138 of file Option.cpp.
|
inherited |
returns the information whether this options holds a valid value
Definition at line 69 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 144 of file Option.cpp.
References Option::myAmWritable.
Referenced by OptionsCont::isWriteable(), and OptionsCont::set().
|
inlinestaticinherited |
Create a new Option of the given type with given default value but make it unset.
Definition at line 269 of file Option.h.
References Option::markSet(), Option::operator=(), and Option::Option().
|
protectedinherited |
Marks the information as set.
Sets the "myAmSet" - information. Returns whether the option was writeable before.
Definition at line 109 of file Option.cpp.
References Option::myAmSet, Option::myAmWritable, and Option::myHaveTheDefaultValue.
Referenced by Option::makeUnsetWithDefault(), set(), Option_String::set(), Option_Float::set(), Option_Bool::set(), Option_BoolExtended::set(), Option_IntVector::set(), and Option_FloatVector::set().
Option_Integer & Option_Integer::operator= | ( | const Option_Integer & | s | ) |
Assignment operator.
Definition at line 200 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 156 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 150 of file Option.cpp.
References Option::myAmWritable.
|
virtual |
Stores the given value after parsing it into an integer.
The value is converted into an integer 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 an integer, an InvalidArgument is thrown.
InvalidArgument | If the value could not be converted into an integer |
Implements Option.
Definition at line 217 of file Option.cpp.
References Option::markSet(), myValue, and StringUtils::toInt().
|
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 119 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 307 of file Option.h.
Referenced by Option::getTypeName(), Option_Bool::Option_Bool(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_FloatVector::Option_FloatVector(), 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 393 of file Option.h.
Referenced by getInt(), getValueString(), operator=(), Option_Integer(), and set().