Eclipse SUMO - Simulation of Urban MObility
Option_Integer Class Reference

An integer-option. More...

#include <Option.h>

Inheritance diagram for Option_Integer:
Collaboration diagram for Option_Integer:

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...
 
int getInt () const
 Returns the stored integer value. More...
 
virtual const IntVectorgetIntVector () const
 Returns the stored integer vector. More...
 
virtual std::string getString () const
 Returns the stored string value. More...
 
virtual const StringVectorgetStringVector () const
 Returns the stored string vector. 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_Integeroperator= (const Option_Integer &s)
 Assignment operator. More...
 
 Option_Integer (const Option_Integer &s)
 Copy constructor. More...
 
 Option_Integer (int value)
 Constructor for an option with a default value. 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

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

Detailed Description

An integer-option.

Definition at line 331 of file Option.h.

Constructor & Destructor Documentation

◆ Option_Integer() [1/2]

Option_Integer::Option_Integer ( int  value)

Constructor for an option with a default value.

Calls Option(true)

Parameters
[in]valueThis option's default value

Definition at line 183 of file Option.cpp.

References Option::myTypeName.

◆ Option_Integer() [2/2]

Option_Integer::Option_Integer ( const Option_Integer s)

Copy constructor.

Definition at line 192 of file Option.cpp.

References myValue.

◆ ~Option_Integer()

Option_Integer::~Option_Integer ( )

Destructor.

Definition at line 189 of file Option.cpp.

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

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

References Option::myDescription.

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

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

◆ getInt()

int Option_Integer::getInt ( ) const
virtual

Returns the stored integer value.

See also
Option::getInt()
Returns
Returns the stored integer number

Reimplemented from Option.

Definition at line 210 of file Option.cpp.

References myValue.

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

◆ getString()

std::string Option::getString ( ) const
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.

Returns
Returns the stored string if being an instance of Option_String or Option_FileName
Exceptions
InvalidArgumentIf 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().

◆ getStringVector()

const StringVector & Option::getStringVector ( ) const
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.

Returns
Returns the stored string vector if being an instance of Option_StringVector
Exceptions
InvalidArgumentIf 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().

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

References Option::myTypeName.

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

◆ getValueString()

std::string Option_Integer::getValueString ( ) const
virtual

Returns the string-representation of the value.

The stored value is encoded into a string and returned.

See also
std::string Option::getValueString()
Returns
The stored value encoded into a string

Implements Option.

Definition at line 228 of file Option.cpp.

References myValue.

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

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

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

References Option::myHaveTheDefaultValue.

Referenced by OptionsCont::writeConfiguration().

◆ isFileName()

bool Option::isFileName ( ) const
virtualinherited

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

References Option::myAmSet.

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

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

References Option::myAmWritable.

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

◆ makeUnsetWithDefault()

template<class OptionType , class ValueType >
static OptionType* Option::makeUnsetWithDefault ( ValueType  def)
inlinestaticinherited

Create a new Option of the given type with given default value but make it unset.

Note
Was implemented to allow warning once if user didn't set the option, refs. #4567
See also
MSDeviceSSM::insertOptions()

Definition at line 267 of file Option.h.

◆ markSet()

bool Option::markSet ( )
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 108 of file Option.cpp.

References Option::myAmSet, Option::myAmWritable, and Option::myHaveTheDefaultValue.

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

◆ operator=()

Option_Integer & Option_Integer::operator= ( const Option_Integer s)

Assignment operator.

Definition at line 199 of file Option.cpp.

References myValue, and Option::operator=().

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

References Option::myHaveTheDefaultValue.

Referenced by OptionsCont::setDefault().

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

References Option::myAmWritable.

◆ set()

bool Option_Integer::set ( const std::string &  v)
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.

See also
bool Option::set(std::string v)
Returns
Whether the new value could be set
Exceptions
InvalidArgumentIf the value could not be converted into an integer

Implements Option.

Definition at line 216 of file Option.cpp.

References Option::markSet(), myValue, and StringUtils::toInt().

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

References Option::myDescription.

Referenced by OptionsCont::addDescription().

◆ unSet()

void Option::unSet ( )
inherited

marks this option as unset

Definition at line 118 of file Option.cpp.

References Option::myAmSet, and Option::myAmWritable.

Field Documentation

◆ myAmSet

bool Option::myAmSet
privateinherited

information whether the value is set

Definition at line 310 of file Option.h.

Referenced by Option::isSet(), Option::markSet(), Option::operator=(), and Option::unSet().

◆ myAmWritable

bool Option::myAmWritable
privateinherited

information whether the value may be changed

Definition at line 316 of file Option.h.

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

◆ myDescription

std::string Option::myDescription
privateinherited

The description what this option does.

Definition at line 319 of file Option.h.

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

◆ myHaveTheDefaultValue

bool Option::myHaveTheDefaultValue
privateinherited

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

Definition at line 313 of file Option.h.

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

◆ myTypeName

std::string Option::myTypeName
protectedinherited

◆ myValue

int Option_Integer::myValue
private

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

Definition at line 391 of file Option.h.

Referenced by getInt(), getValueString(), operator=(), Option_Integer(), and set().


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