![]() |
Eclipse SUMO - Simulation of Urban MObility
|
A class representing a single program 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 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 StringVector & | getStringVector () const |
Returns the stored string vector. More... | |
virtual const std::string & | getTypeName () const |
Returns the mml-type name of this option. More... | |
virtual std::string | getValueString () const =0 |
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... | |
void | resetDefault () |
Resets the option to be on its default value. More... | |
void | resetWritable () |
Resets the option to be writeable. More... | |
virtual bool | set (const std::string &v)=0 |
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 () |
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... | |
virtual Option & | operator= (const Option &s) |
Assignment operator. More... | |
Option (bool set=false) | |
Constructor. More... | |
Option (const Option &s) | |
Copy constructor. 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... | |
A class representing a single program option.
The base class for a single program option. All options which hold values are derived from this class as the type of stored values may differ.
Most of the getter-methods throw exceptions because this base class is not meant to hold any values by itself. Instead, the derived classes implement the appropriate method (Option_Integer implements getInt, f.e.). So, when one tries to retrieve a value which is not of the type of the option, an exception will be thrown. This behaviour is meant to be valid, because errors like this one only occur when building and testing the application.
Due to described behaviour, this class has no public constructors. Only construction of derived, value and type holding, classes is allowed.
At the begin (after being constructed) an Option either has a default value or not. In dependance to this, myHaveTheDefaultValue is set. Also, myAmSet is set to true if a default value was supported. myAmWritable is set to true, indicating that a new value may be set.
Each option may have a description about its purpose stored. Furthermore, it stores a man-readable type name for this option.
|
virtual |
destructor
Definition at line 52 of file Option.cpp.
|
protected |
Constructor.
This constructor should be used by derived classes. The boolean value indicates whether a default value was supplied or not.
[in] | set | A default value was supplied |
Definition at line 43 of file Option.cpp.
|
protected |
Copy constructor.
Definition at line 47 of file Option.cpp.
|
virtual |
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 92 of file Option.cpp.
Referenced by OptionsCont::getBool().
const std::string & Option::getDescription | ( | ) | const |
Returns the description of what this option does.
The description stored in myDescription is returned.
Definition at line 161 of file Option.cpp.
References myDescription.
Referenced by OptionsCont::getDescription(), OptionsCont::printHelpOnTopic(), and OptionsCont::writeConfiguration().
|
virtual |
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 74 of file Option.cpp.
Referenced by OptionsCont::getFloat().
|
virtual |
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 80 of file Option.cpp.
Referenced by OptionsCont::getInt().
|
virtual |
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 98 of file Option.cpp.
Referenced by OptionsCont::getIntVector().
|
virtual |
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 86 of file Option.cpp.
Referenced by OptionsCont::getString().
|
virtual |
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 103 of file Option.cpp.
Referenced by OptionsCont::getStringVector().
|
virtual |
Returns the mml-type name of this option.
The type name stored in myTypeName is returned.
Definition at line 173 of file Option.cpp.
References myTypeName.
Referenced by OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().
|
pure virtual |
Returns the string-representation of the value.
The stored value is encoded into a string and returned.
Implemented in Option_FileName, Option_StringVector, Option_IntVector, Option_BoolExtended, Option_Bool, Option_Float, Option_String, and Option_Integer.
Referenced by OptionsCont::writeConfiguration().
|
virtual |
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 125 of file Option.cpp.
Referenced by OptionsCont::isBool(), OptionsCont::printHelp(), and OptionsCont::printHelpOnTopic().
|
virtual |
Returns the information whether the option holds the default value.
Definition at line 131 of file Option.cpp.
References myHaveTheDefaultValue.
Referenced by OptionsCont::writeConfiguration().
|
virtual |
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 137 of file Option.cpp.
bool Option::isSet | ( | ) | const |
returns the information whether this options holds a valid value
Definition at line 68 of file Option.cpp.
References myAmSet.
Referenced by OptionsCont::checkDependingSuboptions(), OptionsCont::isUsableFileList(), and OptionsCont::writeConfiguration().
bool Option::isWriteable | ( | ) | const |
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 143 of file Option.cpp.
References myAmWritable.
Referenced by OptionsCont::isWriteable(), and OptionsCont::set().
|
inlinestatic |
|
protected |
Marks the information as set.
Sets the "myAmSet" - information. Returns whether the option was writeable before.
Definition at line 108 of file Option.cpp.
References myAmSet, myAmWritable, and myHaveTheDefaultValue.
Referenced by Option_Integer::set(), Option_String::set(), Option_Float::set(), Option_Bool::set(), Option_BoolExtended::set(), Option_IntVector::set(), and Option_StringVector::set().
Assignment operator.
Definition at line 56 of file Option.cpp.
References myAmSet, myAmWritable, and myHaveTheDefaultValue.
Referenced by Option_Bool::operator=(), Option_BoolExtended::operator=(), Option_Float::operator=(), Option_Integer::operator=(), Option_IntVector::operator=(), Option_String::operator=(), and Option_StringVector::operator=().
void Option::resetDefault | ( | ) |
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 155 of file Option.cpp.
References myHaveTheDefaultValue.
Referenced by OptionsCont::setDefault().
void Option::resetWritable | ( | ) |
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 149 of file Option.cpp.
References myAmWritable.
|
pure virtual |
Stores the given value.
This method is overriden by all option classes. The value is converted into the proper type 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 the type, an InvalidArgument is thrown.
InvalidArgument | If the value could not be converted |
Implemented in Option_StringVector, Option_IntVector, Option_BoolExtended, Option_Bool, Option_Float, Option_String, and Option_Integer.
Referenced by OptionsCont::set().
void Option::setDescription | ( | const std::string & | desc | ) |
Sets the description of what this option does.
The description stored in myDescription is returned.
Definition at line 167 of file Option.cpp.
References myDescription.
Referenced by OptionsCont::addDescription().
void Option::unSet | ( | ) |
marks this option as unset
Definition at line 118 of file Option.cpp.
References myAmSet, and myAmWritable.
|
private |
|
private |
information whether the value may be changed
Definition at line 316 of file Option.h.
Referenced by isWriteable(), markSet(), operator=(), resetWritable(), and unSet().
|
private |
The description what this option does.
Definition at line 319 of file Option.h.
Referenced by getDescription(), and setDescription().
|
private |
information whether the value is the default value (is then set)
Definition at line 313 of file Option.h.
Referenced by isDefault(), markSet(), operator=(), and resetDefault().
|
protected |
A type name for this option (has presets, but may be overwritten)
Definition at line 305 of file Option.h.
Referenced by getTypeName(), Option_Bool::Option_Bool(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), Option_String::Option_String(), and Option_StringVector::Option_StringVector().