SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Option_Integer Class Reference

An integer-option. More...

#include <Option.h>

Inheritance diagram for Option_Integer:
Option

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 SUMOReal getFloat () const
 Returns the stored SUMOReal value.
int getInt () const
 Returns the stored integer value.
virtual const IntVectorgetIntVector () const
 Returns the stored integer vector.
virtual std::string getString () const
 Returns the stored string value.
virtual const std::string & getTypeName () const
 Returns the mml-type name of this option.
std::string getValueString () const
 Returns the string-representation of the value.
virtual bool isBool () const
 Returns the information whether the option is a bool option.
virtual bool isDefault () const
 Returns the information whether the option holds the default value.
virtual bool isFileName () const
 Returns the information whether this option is a file name.
bool isSet () const
 returns the information whether this options holds a valid value
bool isWriteable () const
 Returns the information whether the option may be set a further time.
Option_Integeroperator= (const Option_Integer &s)
 Assignment operator.
 Option_Integer ()
 Constructor for an option with no default value.
 Option_Integer (int value)
 Constructor for an option with a default value.
 Option_Integer (const Option_Integer &s)
 Copy constructor.
void resetWritable ()
 Resets the option to be writeable.
bool set (const std::string &v)
 Stores the given value after parsing it into an integer.
void setDescription (const std::string &desc)
 Sets the description of what this option does.
 ~Option_Integer ()
 Destructor.

Protected Member Functions

bool markSet ()
 Marks the information as set.

Protected Attributes

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

Private Attributes

int myValue

Detailed Description

An integer-option.

Definition at line 303 of file Option.h.


Constructor & Destructor Documentation

Option_Integer::Option_Integer ( )

Constructor for an option with no default value.

Calls Option(false)

Definition at line 177 of file Option.cpp.

References Option::myTypeName.

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::Option_Integer ( const Option_Integer s)

Copy constructor.

Definition at line 192 of file Option.cpp.

References myValue.

Option_Integer::~Option_Integer ( )

Destructor.

Definition at line 189 of file Option.cpp.


Member Function Documentation

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

Referenced by OptionsCont::getBool().

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

References Option::myDescription.

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

SUMOReal Option::getFloat ( ) const
virtualinherited

Returns the stored SUMOReal 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 85 of file Option.cpp.

Referenced by OptionsCont::getFloat().

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.

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

Referenced by OptionsCont::getIntVector().

std::string Option::getString ( ) const
virtualinherited

Returns the stored string value.

Option_String and Option_FileName return the stored string in this method's reimplementation. 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
Exceptions:
InvalidArgumentIf the class is not an instance of Option_String

Reimplemented in Option_String.

Definition at line 97 of file Option.cpp.

Referenced by OptionsCont::getString(), and OptionsCont::getStringVector().

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

References Option::myTypeName.

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

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.

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(), and OptionsCont::printHelp().

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

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.

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

References Option::myAmSet.

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

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

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

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

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

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

Assignment operator.

Definition at line 199 of file Option.cpp.

References myValue.

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.

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(), and myValue.

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

References Option::myDescription.

Referenced by OptionsCont::addDescription().


Field Documentation

std::string Option::myTypeName
protectedinherited
int Option_Integer::myValue
private

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

Definition at line 370 of file Option.h.

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


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