#include <Option.h>

Inheritance diagram for Option_FileName:

Collaboration diagram for Option_FileName:

Public Member Functions
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.

virtual 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

std::string	getString () const
	Legacy method that returns the stored filenames as a comma-separated string.

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.

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

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

virtual 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_FileName ()
	Constructor for an option with no default value.

	Option_FileName (const StringVector &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 a vector of strings.

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.

StringVector	myValue
	the value, valid only when the base-classes "myAmSet"-member is true

Detailed Description

Definition at line 682 of file Option.h.

Constructor & Destructor Documentation

◆ Option_FileName() [1/2]

Option_FileName::Option_FileName ( )

Constructor for an option with no default value.

Definition at line 499 of file Option.cpp.

References Option::myTypeName.

◆ Option_FileName() [2/2]

Option_FileName::Option_FileName ( const StringVector & value )

Constructor for an option with a default value.

Parameters

[in] value This option's default value

Definition at line 505 of file Option.cpp.

References Option::myTypeName.

Member Function Documentation

◆ getBool()

bool Option::getBool ( ) const

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.

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

inherited

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 Option::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

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.

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

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.

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

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.

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

inherited

retrieve list separator

Definition at line 235 of file Option.cpp.

References Option::myListSeparator.

◆ getString()

std::string Option_FileName::getString ( ) const

virtual

Legacy method that returns the stored filenames as a comma-separated string.

See also: std::string Option::getString(); std::string StringVector::getValueString()

Returns: Returns comma-separated string of the stored filenames

Deprecated:: Legacy method used when Option_FileName was still derived from Option_String; not in line with code style of the Options sub-system.

Reimplemented from Option.

Definition at line 518 of file Option.cpp.

References Option_StringVector::getStringVector(), and joinToString().

◆ getStringVector()

const StringVector & Option_StringVector::getStringVector ( ) const

virtualinherited

Returns the stored string vector.

See also: const StringVector &Option::getStringVector()

Returns: Returns the stored string vector

Reimplemented from Option.

Definition at line 478 of file Option.cpp.

References Option_StringVector::myValue.

Referenced by getString().

Here is the caller graph for this function:

◆ getSubTopic()

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

inherited

Returns the subtopic to which this option belongs.

Definition at line 245 of file Option.cpp.

References Option::mySubTopic.

Referenced by OptionsCont::getSubTopic().

Here is the caller graph for this function:

◆ getTypeName()

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

virtualinherited

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 Option::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

inherited

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

Here is the caller graph for this function:

◆ isAdditional()

bool Option::isAdditional ( ) const

virtualinherited

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

virtualinherited

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

virtualinherited

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

virtualinherited

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 Option::myHaveTheDefaultValue.

Referenced by OptionsCont::writeConfiguration().

Here is the caller graph for this function:

◆ isEdge()

bool Option::isEdge ( ) const

virtualinherited

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

virtualinherited

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_FileName::isFileName ( ) const

virtual

Returns true, the information whether this option is a file name.

Returns true.

Returns: true

Reimplemented from Option.

Definition at line 512 of file Option.cpp.

◆ isFloat()

bool Option::isFloat ( ) const

virtualinherited

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

virtualinherited

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

virtualinherited

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

inherited

check if option is positional

Definition at line 225 of file Option.cpp.

References Option::myPositional.

◆ isRequired()

bool Option::isRequired ( ) const

inherited

check if option is required

Definition at line 214 of file Option.cpp.

References Option::myRequired.

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

Here is the caller graph for this function:

◆ isRoute()

bool Option::isRoute ( ) const

virtualinherited

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

inherited

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 Option::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

virtualinherited

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

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.

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

Definition at line 184 of file Option.cpp.

References Option::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 )

protectedinherited

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 Option::myAmSet, Option::myAmWritable, Option::myHaveTheDefaultValue, and Option::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 ( )

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

Here is the caller graph for this function:

◆ resetWritable()

void Option::resetWritable ( )

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.

◆ set()

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

virtualinherited

Stores the given value after parsing it into a vector of strings.

The value is converted into a vector of strings 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 strings, an InvalidArgument is thrown.

See also: bool Option::set(std::string v)

Returns: Whether the new value could be set

Exceptions

InvalidArgument If the value could not be converted into a vector of strings

Implements Option.

Definition at line 484 of file Option.cpp.

References Option::getValueString(), StringTokenizer::hasNext(), Option::markSet(), Option_StringVector::myValue, StringTokenizer::next(), and StringUtils::prune().

◆ setDescription()

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

inherited

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 Option::myDescription.

Referenced by OptionsCont::addDescription().

Here is the caller graph for this function:

◆ setListSeparator()

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

inherited

set list separator

Definition at line 240 of file Option.cpp.

References Option::myListSeparator.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setPositional()

void Option::setPositional ( )

inherited

mark option as positional

Definition at line 230 of file Option.cpp.

References Option::myPositional.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setRequired()

void Option::setRequired ( )

inherited

mark option as required

Definition at line 220 of file Option.cpp.

References Option::myRequired.

Referenced by OptionsCont::setFurtherAttributes().

Here is the caller graph for this function:

◆ setSubtopic()

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

inherited

Sets the subtopic to which this option belongs.

Definition at line 251 of file Option.cpp.

References Option::mySubTopic.

Referenced by OptionsCont::addDescription().

Here is the caller graph for this function:

Field Documentation

◆ myAmSet

bool Option::myAmSet

privateinherited

information whether the value is set

Definition at line 360 of file Option.h.

Referenced by Option::isSet(), and Option::markSet().

◆ myAmWritable

bool Option::myAmWritable = true

privateinherited

information whether the value may be changed

Definition at line 366 of file Option.h.

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

◆ myDescription

std::string Option::myDescription

privateinherited

The description what this option does.

Definition at line 369 of file Option.h.

Referenced by Option::getDescription(), and Option::setDescription().

◆ myHaveTheDefaultValue

bool Option::myHaveTheDefaultValue = true

privateinherited

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

Definition at line 363 of file Option.h.

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

◆ myListSeparator

std::string Option::myListSeparator = ""

privateinherited

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

Definition at line 378 of file Option.h.

Referenced by Option::getListSeparator(), and Option::setListSeparator().

◆ myPositional

bool Option::myPositional = false

privateinherited

this option is positional (needed for python tools)

Definition at line 375 of file Option.h.

Referenced by Option::isPositional(), and Option::setPositional().

◆ myRequired

bool Option::myRequired = false

privateinherited

this option is required (needed for python tools)

Definition at line 372 of file Option.h.

Referenced by Option::isRequired(), and Option::setRequired().

◆ mySubTopic

std::string Option::mySubTopic

privateinherited

The subtopic to which this option belongs.

Definition at line 381 of file Option.h.

Referenced by Option::getSubTopic(), and Option::setSubtopic().

◆ myTypeName

std::string Option::myTypeName

protectedinherited

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

Definition at line 353 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_IntVector(), Option_IntVector::Option_IntVector(), Option_String::Option_String(), Option_String::Option_String(), Option_StringVector::Option_StringVector(), and Option_StringVector::Option_StringVector().

◆ myValue

StringVector Option_StringVector::myValue

privateinherited

the value, valid only when the base-classes "myAmSet"-member is true

Definition at line 675 of file Option.h.

Referenced by Option_StringVector::getStringVector(), and Option_StringVector::set().

◆ myValueString

std::string Option::myValueString

protectedinherited

The original set string.

Definition at line 356 of file Option.h.

Referenced by Option::getValueString(), Option::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_FileName() [1/2]

◆ Option_FileName() [2/2]

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

◆ myValue

◆ myValueString