A class representing a single program option. More...

#include <Option.h>

Inheritance diagram for Option:

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...

const std::string &	getListSeparator () const
	retrieve list separator More...

virtual std::string	getString () const
	Returns the stored string value. More...

virtual const StringVector &	getStringVector () const
	Returns the stored string vector. More...

const std::string &	getSubTopic () const
	Returns the subtopic to which this option belongs. 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	isAdditional () const
	Returns the information whether this option is an additional file. More...

virtual bool	isBool () const
	Returns the information whether the option is a bool option. More...

virtual bool	isData () const
	Returns the information whether this option is a data file. More...

virtual bool	isDefault () const
	Returns the information whether the option holds the default value. More...

virtual bool	isEdge () const
	Returns the information whether this option is an edge. More...

virtual bool	isEdgeVector () const
	Returns the information whether this option is a vector of edges. More...

virtual bool	isFileName () const
	Returns the information whether this option is a file name. More...

virtual bool	isFloat () const
	Returns the information whether the option is a float option. More...

virtual bool	isInteger () const
	Returns the information whether the option is a int option. More...

virtual bool	isNetwork () const
	Returns the information whether this option is a network file. More...

bool	isPositional () const
	check if option is positional More...

bool	isRequired () const
	check if option is required More...

virtual bool	isRoute () const
	Returns the information whether this option is a route file. More...

bool	isSet () const
	returns the information whether this options holds a valid value More...

virtual bool	isSumoConfig () const
	Returns the information whether this option is a sumo config file. 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, const std::string &orig, const bool append)=0
	Stores the given value. More...

void	setDescription (const std::string &desc)
	Sets the description of what this option does. More...

void	setListSeparator (const std::string &listSep)
	set list separator More...

void	setPositional ()
	mark option as positional More...

void	setRequired ()
	mark option as required More...

void	setSubtopic (const std::string &subtopic)
	Sets the subtopic to which this option belongs. More...

virtual	~Option ()
	destructor More...

Protected Member Functions
bool	markSet (const std::string &orig)
	Marks the information as set. More...

	Option (bool set=false)
	Constructor. More...

Protected Attributes
std::string	myTypeName
	A type name for this option (has presets, but may be overwritten) More...

std::string	myValueString
	The original set string. More...

Private Attributes
bool	myAmSet
	information whether the value is set More...

bool	myAmWritable = true
	information whether the value may be changed More...

std::string	myDescription
	The description what this option does. More...

bool	myHaveTheDefaultValue = true
	information whether the value is the default value (is then set) More...

std::string	myListSeparator = ""
	the list separator for this option (needed for python tools) More...

bool	myPositional = false
	this option is positional (needed for python tools) More...

bool	myRequired = false
	this option is required (needed for python tools) More...

std::string	mySubTopic
	The subtopic to which this option belongs. More...

Detailed Description

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 dependence 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.

Definition at line 72 of file Option.h.

Constructor & Destructor Documentation

◆ ~Option()

Option::~Option ( )

virtual

destructor

Definition at line 49 of file Option.cpp.

◆ Option()

Option::Option ( bool set = false )

protected

Constructor.

This constructor should be used by derived classes. The boolean value indicates whether a default value was supplied or not.

Parameters

[in] set A default value was supplied

Definition at line 44 of file Option.cpp.

Member Function Documentation

◆ getBool()

bool Option::getBool ( ) const

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.

Returns: Returns the stored boolean if being an instance of Option_Bool

Exceptions

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().

Here is the caller graph for this function:

◆ getDescription()

const std::string & Option::getDescription ( ) const

Returns the description of what this option does.

The description stored in myDescription is returned.

Returns: The description of this option's purpose

Definition at line 202 of file Option.cpp.

References myDescription.

Referenced by GNEPythonToolDialogElements::Argument::Argument(), OptionsCont::getDescription(), OptionsCont::printHelpOnTopic(), and OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ getFloat()

double Option::getFloat ( ) const

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.

Returns: Returns the stored real number if being an instance of Option_Float

Exceptions

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().

Here is the caller graph for this function:

◆ getInt()

int Option::getInt ( ) const

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.

Returns: Returns the stored integer number if being an instance of Option_Integer

Exceptions

InvalidArgument If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

Definition at line 65 of file Option.cpp.

Referenced by OptionsCont::getInt().

Here is the caller graph for this function:

◆ getIntVector()

const IntVector & Option::getIntVector ( ) const

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.

Returns: Returns the stored integer vector if being an instance of Option_IntVector

Exceptions

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().

Here is the caller graph for this function:

◆ getListSeparator()

const std::string & Option::getListSeparator ( ) const

retrieve list separator

Definition at line 235 of file Option.cpp.

References myListSeparator.

◆ getString()

std::string Option::getString ( ) const

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.

Returns: Returns the stored string if being an instance of Option_String or Option_FileName

Exceptions

InvalidArgument If the class is not an instance of Option_String or Option_FileName

Reimplemented in Option_FileName, and Option_String.

Definition at line 71 of file Option.cpp.

Referenced by OptionsCont::getString().

Here is the caller graph for this function:

◆ getStringVector()

const StringVector & Option::getStringVector ( ) const

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.

Returns: Returns the stored string vector if being an instance of Option_StringVector

Exceptions

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().

Here is the caller graph for this function:

◆ getSubTopic()

const std::string & Option::getSubTopic ( ) const

Returns the subtopic to which this option belongs.

Definition at line 245 of file Option.cpp.

References mySubTopic.

Referenced by OptionsCont::getSubTopic().

Here is the caller graph for this function:

◆ getTypeName()

const std::string & Option::getTypeName ( ) const

virtual

Returns the mml-type name of this option.

The type name stored in myTypeName is returned.

Returns: The man-readable type name

Definition at line 257 of file Option.cpp.

References myTypeName.

Referenced by GNEPythonToolDialogElements::Argument::Argument(), OptionsCont::getTypeName(), OptionsCont::printHelp(), OptionsCont::printHelpOnTopic(), OptionsCont::writeConfiguration(), and OptionsCont::writeSchema().

Here is the caller graph for this function:

◆ getValueString()

const std::string & Option::getValueString ( ) const

Returns the string-representation of the value.

The stored value is encoded into a string and returned.

Returns: The stored value encoded into a string-

Definition at line 106 of file Option.cpp.

References 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().

Here is the caller graph for this function:

◆ isAdditional()

bool Option::isAdditional ( ) const

virtual

Returns the information whether this option is an additional file.

Returns false. Only Option_Additional overrides this method returning true.

Returns: true if the Option is an Option_Additional, false otherwise

Reimplemented in Option_Additional.

Definition at line 148 of file Option.cpp.

◆ isBool()

bool Option::isBool ( ) const

virtual

Returns the information whether the option is a bool option.

Returns false. Only Option_Bool overrides this method returning true.

Returns: true if the Option is an Option_Bool, false otherwise

Reimplemented in Option_Bool.

Definition at line 130 of file Option.cpp.

Referenced by OptionsCont::isBool(), OptionsCont::printHelp(), and OptionsCont::printHelpOnTopic().

Here is the caller graph for this function:

◆ isData()

bool Option::isData ( ) const

virtual

Returns the information whether this option is a data file.

Returns false. Only Option_Data overrides this method returning true.

Returns: true if the Option is an Option_Data, false otherwise

Reimplemented in Option_Data.

Definition at line 160 of file Option.cpp.

◆ isDefault()

bool Option::isDefault ( ) const

virtual

Returns the information whether the option holds the default value.

Returns: true if the option was not set from command line / configuration, false otherwise

Definition at line 112 of file Option.cpp.

References myHaveTheDefaultValue.

Referenced by OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isEdge()

bool Option::isEdge ( ) const

virtual

Returns the information whether this option is an edge.

Returns false. Only Option_Edge overrides this method returning true.

Returns: true if the Option is an Option_Edge, false otherwise

Reimplemented in Option_Edge.

Definition at line 172 of file Option.cpp.

◆ isEdgeVector()

bool Option::isEdgeVector ( ) const

virtual

Returns the information whether this option is a vector of edges.

Returns false. Only Option_EdgeVector overrides this method returning true.

Returns: true if the Option is an Option_EdgeVector, false otherwise

Reimplemented in Option_EdgeVector.

Definition at line 178 of file Option.cpp.

◆ isFileName()

bool Option::isFileName ( ) const

virtual

Returns the information whether this option is a file name.

Returns false. Only Option_FileName overrides this method returning true.

Returns: true if the Option is an Option_FileName, false otherwise

Reimplemented in Option_FileName.

Definition at line 136 of file Option.cpp.

Referenced by OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isFloat()

bool Option::isFloat ( ) const

virtual

Returns the information whether the option is a float option.

Returns false. Only Option_Float overrides this method returning true.

Returns: true if the Option is an Option_Float, false otherwise

Reimplemented in Option_Float.

Definition at line 124 of file Option.cpp.

◆ isInteger()

bool Option::isInteger ( ) const

virtual

Returns the information whether the option is a int option.

Returns false. Only Option_Integer overrides this method returning true.

Returns: true if the Option is an Option_Integer, false otherwise

Reimplemented in Option_Integer.

Definition at line 118 of file Option.cpp.

◆ isNetwork()

bool Option::isNetwork ( ) const

virtual

Returns the information whether this option is a network file.

Returns false. Only Option_Network overrides this method returning true.

Returns: true if the Option is an Option_Network, false otherwise

Reimplemented in Option_Network.

Definition at line 142 of file Option.cpp.

◆ isPositional()

bool Option::isPositional ( ) const

check if option is positional

Definition at line 225 of file Option.cpp.

References myPositional.

◆ isRequired()

bool Option::isRequired ( ) const

check if option is required

Definition at line 214 of file Option.cpp.

References myRequired.

Referenced by GNEPythonToolDialogElements::Argument::Argument().

Here is the caller graph for this function:

◆ isRoute()

bool Option::isRoute ( ) const

virtual

Returns the information whether this option is a route file.

Returns false. Only Option_Route overrides this method returning true.

Returns: true if the Option is an Option_Route, false otherwise

Reimplemented in Option_Route.

Definition at line 154 of file Option.cpp.

◆ isSet()

bool Option::isSet ( ) const

returns the information whether this options holds a valid value

Returns: Whether a value has been set

Definition at line 53 of file Option.cpp.

References myAmSet.

Referenced by TemplateHandler::addOption(), OptionsCont::checkDependingSuboptions(), OptionsCont::isUsableFileList(), and OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isSumoConfig()

bool Option::isSumoConfig ( ) const

virtual

Returns the information whether this option is a sumo config file.

Returns false. Only Option_SumoConfig overrides this method returning true.

Returns: true if the Option is an Option_SumoConfig, false otherwise

Reimplemented in Option_SumoConfig.

Definition at line 166 of file Option.cpp.

◆ isWriteable()

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.

Returns: Whether the option may be set from the command line / configuration

Definition at line 184 of file Option.cpp.

References myAmWritable.

Referenced by OptionsCont::isWriteable(), OptionsCont::set(), and OptionsCont::setDefault().

Here is the caller graph for this function:

◆ markSet()

bool Option::markSet ( const std::string & orig )

protected

Marks the information as set.

Sets the "myAmSet" - information. Returns whether the option was writeable before.

Returns: Whether the option was not set before.

Definition at line 95 of file Option.cpp.

References myAmSet, myAmWritable, myHaveTheDefaultValue, and myValueString.

Referenced by Option_Integer::set(), Option_String::set(), Option_Float::set(), Option_Bool::set(), Option_BoolExtended::set(), Option_IntVector::set(), and Option_StringVector::set().

Here is the caller graph for this function:

◆ resetDefault()

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 196 of file Option.cpp.

References myHaveTheDefaultValue.

Referenced by OptionsCont::resetDefault(), and OptionsCont::setDefault().

Here is the caller graph for this function:

◆ resetWritable()

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 190 of file Option.cpp.

References myAmWritable.

◆ set()

virtual bool Option::set	(	const std::string &	v,
		const std::string &	orig,
		const bool	append
	)

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.

Returns: Whether the new value could be set

Exceptions

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 TemplateHandler::addOption(), and OptionsCont::set().

Here is the caller graph for this function:

◆ setDescription()

void Option::setDescription ( const std::string & desc )

Sets the description of what this option does.

The description stored in myDescription is returned.

Returns: The description of this option's purpose

Definition at line 208 of file Option.cpp.

References myDescription.

Referenced by OptionsCont::addDescription().

Here is the caller graph for this function:

◆ setListSeparator()

void Option::setListSeparator ( const std::string & listSep )

set list separator

Definition at line 240 of file Option.cpp.

References myListSeparator.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setPositional()

void Option::setPositional ( )

mark option as positional

Definition at line 230 of file Option.cpp.

References myPositional.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setRequired()

void Option::setRequired ( )

mark option as required

Definition at line 220 of file Option.cpp.

References myRequired.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setSubtopic()

void Option::setSubtopic ( const std::string & subtopic )

Sets the subtopic to which this option belongs.

Definition at line 251 of file Option.cpp.

References mySubTopic.

Referenced by OptionsCont::addDescription().

Here is the caller graph for this function:

Field Documentation

◆ myAmSet

bool Option::myAmSet

private

information whether the value is set

Definition at line 360 of file Option.h.

Referenced by isSet(), and markSet().

◆ myAmWritable

bool Option::myAmWritable = true

private

information whether the value may be changed

Definition at line 366 of file Option.h.

Referenced by isWriteable(), markSet(), and resetWritable().

◆ myDescription

std::string Option::myDescription

private

The description what this option does.

Definition at line 369 of file Option.h.

Referenced by getDescription(), and setDescription().

◆ myHaveTheDefaultValue

bool Option::myHaveTheDefaultValue = true

private

information whether the value is the default value (is then set)

Definition at line 363 of file Option.h.

Referenced by isDefault(), markSet(), and resetDefault().

◆ myListSeparator

std::string Option::myListSeparator = ""

private

the list separator for this option (needed for python tools)

Definition at line 378 of file Option.h.

Referenced by getListSeparator(), and setListSeparator().

◆ myPositional

bool Option::myPositional = false

private

this option is positional (needed for python tools)

Definition at line 375 of file Option.h.

Referenced by isPositional(), and setPositional().

◆ myRequired

bool Option::myRequired = false

private

this option is required (needed for python tools)

Definition at line 372 of file Option.h.

Referenced by isRequired(), and setRequired().

◆ mySubTopic

std::string Option::mySubTopic

private

The subtopic to which this option belongs.

Definition at line 381 of file Option.h.

Referenced by getSubTopic(), and setSubtopic().

◆ myTypeName

std::string Option::myTypeName

protected

A type name for this option (has presets, but may be overwritten)

Definition at line 353 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().

◆ myValueString

std::string Option::myValueString

protected

The original set string.

Definition at line 356 of file Option.h.

Referenced by getValueString(), markSet(), Option_Bool::Option_Bool(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), Option_String::Option_String(), and Option_StringVector::Option_StringVector().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Option()

◆ Option()

Member Function Documentation

◆ getBool()

◆ getDescription()

◆ getFloat()

◆ getInt()

◆ getIntVector()

◆ getListSeparator()

◆ getString()

◆ getStringVector()

◆ getSubTopic()

◆ getTypeName()

◆ getValueString()

◆ isAdditional()

◆ isBool()

◆ isData()

◆ isDefault()

◆ isEdge()

◆ isEdgeVector()

◆ isFileName()

◆ isFloat()

◆ isInteger()

◆ isNetwork()

◆ isPositional()

◆ isRequired()

◆ isRoute()

◆ isSet()

◆ isSumoConfig()

◆ isWriteable()

◆ markSet()

◆ resetDefault()

◆ resetWritable()

◆ set()

◆ setDescription()

◆ setListSeparator()

◆ setPositional()

◆ setRequired()

◆ setSubtopic()

Field Documentation

◆ myAmSet

◆ myAmWritable

◆ myDescription

◆ myHaveTheDefaultValue

◆ myListSeparator

◆ myPositional

◆ myRequired

◆ mySubTopic

◆ myTypeName

◆ myValueString