Eclipse SUMO - Simulation of Urban MObility
|
#include <Option.h>
Public Member Functions | |
virtual Option * | clone () const =0 |
Returns a copy of this option. | |
virtual bool | getBool () const |
Returns the stored boolean value. | |
const std::string & | getDescription () const |
Returns the description of what this option does. | |
virtual double | getFloat () const |
Returns the stored double value. | |
int | getInt () const |
Returns the stored integer value. | |
virtual const IntVector & | getIntVector () const |
Returns the stored integer vector. | |
const std::string & | getListSeparator () const |
retrieve list separator | |
virtual std::string | getString () const |
Returns the stored string value. | |
virtual const StringVector & | getStringVector () const |
Returns the stored string vector. | |
const std::string & | getSubTopic () const |
Returns the subtopic to which this option belongs. | |
virtual const std::string & | getTypeName () const |
Returns the mml-type name of this option. | |
const std::string & | getValueString () const |
Returns the string-representation of the value. | |
virtual bool | isAdditional () const |
Returns the information whether this option is an additional file. | |
virtual bool | isBool () const |
Returns the information whether the option is a bool option. | |
virtual bool | isData () const |
Returns the information whether this option is a data file. | |
virtual bool | isDefault () const |
Returns the information whether the option holds the default value. | |
virtual bool | isEdge () const |
Returns the information whether this option is an edge. | |
virtual bool | isEdgeVector () const |
Returns the information whether this option is a vector of edges. | |
virtual bool | isFileName () const |
Returns the information whether this option is a file name. | |
virtual bool | isFloat () const |
Returns the information whether the option is a float option. | |
bool | isInteger () const |
Returns the information whether the option is a int option. | |
virtual bool | isNetwork () const |
Returns the information whether this option is a network file. | |
bool | isPositional () const |
check if option is positional | |
bool | isRequired () const |
check if option is required | |
virtual bool | isRoute () const |
Returns the information whether this option is a route file. | |
bool | isSet () const |
returns the information whether this options holds a valid value | |
virtual bool | isSumoConfig () const |
Returns the information whether this option is a sumo config file. | |
bool | isWriteable () const |
Returns the information whether the option may be set a further time. | |
Option_Integer (int value) | |
Constructor for an option with a default value. | |
void | resetDefault () |
Resets the option to be on its default value. | |
void | resetWritable () |
Resets the option to be writeable. | |
bool | set (const std::string &v, const std::string &orig, const bool append) |
Stores the given value after parsing it into an integer. | |
void | setDescription (const std::string &desc) |
Sets the description of what this option does. | |
void | setListSeparator (const std::string &listSep) |
set list separator | |
void | setPositional () |
mark option as positional | |
void | setRequired () |
mark option as required | |
void | setSubtopic (const std::string &subtopic) |
Sets the subtopic to which this option belongs. | |
Protected Member Functions | |
bool | markSet (const std::string &orig) |
Marks the information as set. | |
Protected Attributes | |
std::string | myTypeName |
A type name for this option (has presets, but may be overwritten) | |
std::string | myValueString |
The original set string. | |
Private Attributes | |
bool | myAmSet |
information whether the value is set | |
bool | myAmWritable = true |
information whether the value may be changed | |
std::string | myDescription |
The description what this option does. | |
bool | myHaveTheDefaultValue = true |
information whether the value is the default value (is then set) | |
std::string | myListSeparator = "" |
the list separator for this option (needed for python tools) | |
bool | myPositional = false |
this option is positional (needed for python tools) | |
bool | myRequired = false |
this option is required (needed for python tools) | |
std::string | mySubTopic |
The subtopic to which this option belongs. | |
int | myValue |
the value, valid only when the base-classes "myAmSet"-member is true | |
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 265 of file Option.cpp.
References Option::myTypeName, Option::myValueString, and toString().
|
pure virtualinherited |
Returns a copy of this option.
|
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 77 of file Option.cpp.
Referenced by GNEPythonToolDialogElements::BoolArgument::BoolArgument(), and OptionsCont::getBool().
|
inherited |
Returns the description of what this option does.
The description stored in myDescription is returned.
Definition at line 202 of file Option.cpp.
References Option::myDescription.
Referenced by GNEPythonToolDialogElements::Argument::Argument(), 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 59 of file Option.cpp.
Referenced by OptionsCont::getFloat().
|
virtual |
Returns the stored integer value.
Reimplemented from Option.
Definition at line 274 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 83 of file Option.cpp.
Referenced by OptionsCont::getIntVector().
|
inherited |
retrieve list separator
Definition at line 235 of file Option.cpp.
References Option::myListSeparator.
|
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_String, and Option_FileName.
Definition at line 71 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 89 of file Option.cpp.
Referenced by OptionsCont::getStringVector().
|
inherited |
Returns the subtopic to which this option belongs.
Definition at line 245 of file Option.cpp.
References Option::mySubTopic.
Referenced by OptionsCont::getSubTopic().
|
virtualinherited |
Returns the mml-type name of this option.
The type name stored in myTypeName is returned.
Definition at line 257 of file Option.cpp.
References Option::myTypeName.
Referenced by GNEPythonToolDialogElements::Argument::Argument(), OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().
|
inherited |
Returns the string-representation of the value.
The stored value is encoded into a string and returned.
Definition at line 106 of file Option.cpp.
References Option::myValueString.
Referenced by GNEPythonToolDialogElements::EdgeArgument::EdgeArgument(), GNEPythonToolDialogElements::EdgeVectorArgument::EdgeVectorArgument(), GNEPythonToolDialogElements::FileNameArgument::FileNameArgument(), GNEPythonToolDialogElements::FloatArgument::FloatArgument(), OptionsCont::getValueString(), GNEPythonToolDialogElements::IntArgument::IntArgument(), Option_StringVector::set(), GNEPythonToolDialogElements::StringArgument::StringArgument(), and OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the information whether this option is an additional file.
Returns false. Only Option_Additional overrides this method returning true.
Reimplemented in Option_Additional.
Definition at line 148 of file Option.cpp.
|
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 130 of file Option.cpp.
Referenced by OptionsCont::isBool(), OptionsCont::printHelp(), and OptionsCont::printHelpOnTopic().
|
virtualinherited |
Returns the information whether this option is a data file.
Returns false. Only Option_Data overrides this method returning true.
Reimplemented in Option_Data.
Definition at line 160 of file Option.cpp.
|
virtualinherited |
Returns the information whether the option holds the default value.
Definition at line 112 of file Option.cpp.
References Option::myHaveTheDefaultValue.
Referenced by OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the information whether this option is an edge.
Returns false. Only Option_Edge overrides this method returning true.
Reimplemented in Option_Edge.
Definition at line 172 of file Option.cpp.
|
virtualinherited |
Returns the information whether this option is a vector of edges.
Returns false. Only Option_EdgeVector overrides this method returning true.
Reimplemented in Option_EdgeVector.
Definition at line 178 of file Option.cpp.
|
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.
Referenced by OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the information whether the option is a float option.
Returns false. Only Option_Float overrides this method returning true.
Reimplemented in Option_Float.
Definition at line 124 of file Option.cpp.
|
virtual |
Returns the information whether the option is a int option.
Returns false. Only Option_Integer overrides this method returning true.
Reimplemented from Option.
Definition at line 292 of file Option.cpp.
|
virtualinherited |
Returns the information whether this option is a network file.
Returns false. Only Option_Network overrides this method returning true.
Reimplemented in Option_Network.
Definition at line 142 of file Option.cpp.
|
inherited |
check if option is positional
Definition at line 225 of file Option.cpp.
References Option::myPositional.
|
inherited |
check if option is required
Definition at line 214 of file Option.cpp.
References Option::myRequired.
Referenced by GNEPythonToolDialogElements::Argument::Argument().
|
virtualinherited |
Returns the information whether this option is a route file.
Returns false. Only Option_Route overrides this method returning true.
Reimplemented in Option_Route.
Definition at line 154 of file Option.cpp.
|
inherited |
returns the information whether this options holds a valid value
Definition at line 53 of file Option.cpp.
References Option::myAmSet.
Referenced by TemplateHandler::addOption(), OptionsCont::checkDependingSuboptions(), OptionsCont::isUsableFileList(), and OptionsCont::writeConfiguration().
|
virtualinherited |
Returns the information whether this option is a sumo config file.
Returns false. Only Option_SumoConfig overrides this method returning true.
Reimplemented in Option_SumoConfig.
Definition at line 166 of file Option.cpp.
|
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 184 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 95 of file Option.cpp.
References Option::myAmSet, Option::myAmWritable, Option::myHaveTheDefaultValue, and Option::myValueString.
Referenced by set(), Option_String::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 196 of file Option.cpp.
References Option::myHaveTheDefaultValue.
Referenced by OptionsCont::resetDefault(), and 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 190 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 280 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 208 of file Option.cpp.
References Option::myDescription.
Referenced by OptionsCont::addDescription().
|
inherited |
set list separator
Definition at line 240 of file Option.cpp.
References Option::myListSeparator.
Referenced by OptionsCont::setFurtherAttributes().
|
inherited |
mark option as positional
Definition at line 230 of file Option.cpp.
References Option::myPositional.
Referenced by OptionsCont::setFurtherAttributes().
|
inherited |
mark option as required
Definition at line 220 of file Option.cpp.
References Option::myRequired.
Referenced by OptionsCont::setFurtherAttributes().
|
inherited |
Sets the subtopic to which this option belongs.
Definition at line 251 of file Option.cpp.
References Option::mySubTopic.
Referenced by OptionsCont::addDescription().
|
privateinherited |
information whether the value is set
Definition at line 368 of file Option.h.
Referenced by Option::isSet(), and Option::markSet().
|
privateinherited |
information whether the value may be changed
Definition at line 374 of file Option.h.
Referenced by Option::isWriteable(), Option::markSet(), and Option::resetWritable().
|
privateinherited |
The description what this option does.
Definition at line 377 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 371 of file Option.h.
Referenced by Option::isDefault(), Option::markSet(), and Option::resetDefault().
|
privateinherited |
the list separator for this option (needed for python tools)
Definition at line 386 of file Option.h.
Referenced by Option::getListSeparator(), and Option::setListSeparator().
|
privateinherited |
this option is positional (needed for python tools)
Definition at line 383 of file Option.h.
Referenced by Option::isPositional(), and Option::setPositional().
|
privateinherited |
this option is required (needed for python tools)
Definition at line 380 of file Option.h.
Referenced by Option::isRequired(), and Option::setRequired().
|
privateinherited |
The subtopic to which this option belongs.
Definition at line 389 of file Option.h.
Referenced by Option::getSubTopic(), and Option::setSubtopic().
|
protectedinherited |
A type name for this option (has presets, but may be overwritten)
Definition at line 361 of file Option.h.
Referenced by Option::getTypeName(), Option_Bool::Option_Bool(), Option_FileName::Option_FileName(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_Integer(), Option_IntVector::Option_IntVector(), Option_IntVector::Option_IntVector(), Option_String::Option_String(), Option_String::Option_String(), Option_StringVector::Option_StringVector(), and Option_StringVector::Option_StringVector().
|
private |
|
protectedinherited |
The original set string.
Definition at line 364 of file Option.h.
Referenced by Option::getValueString(), Option::markSet(), Option_Bool::Option_Bool(), Option_Float::Option_Float(), Option_Integer(), Option_IntVector::Option_IntVector(), Option_String::Option_String(), and Option_StringVector::Option_StringVector().