Option_Bool Class Reference

#include <Option.h>

Inheritance diagram for Option_Bool:

Detailed Description

Definition at line 516 of file Option.h.


Public Member Functions
bool	getBool () const throw (InvalidArgument)
	Returns the stored boolean value.
const std::string &	getDescription () const throw ()
	Returns the description of what this option does.
virtual SUMOReal	getFloat () const throw (InvalidArgument)
	Returns the stored SUMOReal value.
virtual int	getInt () const throw (InvalidArgument)
	Returns the stored integer value.
virtual const IntVector &	getIntVector () const throw (InvalidArgument)
	Returns the stored integer vector.
virtual std::string	getString () const throw (InvalidArgument)
	Returns the stored string value.
virtual const std::string &	getTypeName () const throw ()
	Returns the mml-type name of this option.
std::string	getValueString () const throw (InvalidArgument)
	Returns the string-representation of the value.
bool	isBool () const throw ()
	Returns true, the information whether the option is a bool option.
virtual bool	isDefault () const throw ()
	Returns the information whether the option holds the default value.
virtual bool	isFileName () const throw ()
	Returns the information whether this option is a file name.
bool	isSet () const throw ()
	returns the information whether this options holds a valid value
bool	isWriteable () const throw ()
	Returns the information whether the option may be set a further time.
Option_Bool &	operator= (const Option_Bool &s) throw ()
	Assignment operator.
	Option_Bool (const Option_Bool &s) throw ()
	Copy constructor.
	Option_Bool (bool value) throw ()
	Constructor for an option with a default value.
	Option_Bool () throw ()
	Constructor for an option with no default value.
virtual bool	set (const std::string &v) throw (InvalidArgument)
	Stores the given value (used for non-bool options).
bool	set (bool v) throw (InvalidArgument)
	~Option_Bool () throw ()
	Destructor.
Protected Member Functions
bool	markSet () throw ()
	Marks the information as set.
Protected Attributes
std::string	myTypeName
	A type name for this option (has presets, but may be overwritten).
Private Attributes
bool	myValue
Friends
class	OptionsCont

Constructor & Destructor Documentation

Option_Bool::Option_Bool ( ) throw ()

Constructor for an option with no default value.

Calls Option(false)

Definition at line 356 of file Option.cpp.

References Option::myTypeName.

00357         : Option() {
00358     myTypeName = "BOOL";
00359 }

Option_Bool::Option_Bool ( bool value ) throw ()

Constructor for an option with a default value.

Calls Option(true)

Parameters:

[in] value This option's default value

Definition at line 362 of file Option.cpp.

References Option::myTypeName.

00363         : Option(true), myValue(value) {
00364     myTypeName = "BOOL";
00365 }

Option_Bool::Option_Bool ( const Option_Bool & s ) throw ()

Copy constructor.

Definition at line 371 of file Option.cpp.

References myValue.

00372         : Option(s) {
00373     myValue = s.myValue;
00374 }

Option_Bool::~Option_Bool ( ) throw ()

Destructor.

Definition at line 368 of file Option.cpp.

00368 {}

Member Function Documentation

bool Option_Bool::getBool ( ) const throw (InvalidArgument) [virtual]

Returns the stored boolean value.

See also:: bool Option::getBool()

Returns:: Returns the stored boolean

Reimplemented from Option.

Definition at line 389 of file Option.cpp.

References myValue.

00389                                                   {
00390     return myValue;
00391 }

const std::string & Option::getDescription ( ) const throw () [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 163 of file Option.cpp.

References Option::myDescription.

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

00163                                      {
00164     return myDescription;
00165 }

SUMOReal Option::getFloat ( ) const throw (InvalidArgument) [virtual, inherited]

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:

InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

Definition at line 81 of file Option.cpp.

Referenced by OptionsCont::getFloat().

00081                                               {
00082     throw InvalidArgument("This is not a SUMOReal-option");
00083 }

int Option::getInt ( ) const throw (InvalidArgument) [virtual, inherited]

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

Referenced by OptionsCont::getInt().

00087                                             {
00088     throw InvalidArgument("This is not an int-option");
00089 }

const IntVector & Option::getIntVector ( ) const throw (InvalidArgument) [virtual, inherited]

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

Referenced by OptionsCont::getIntVector().

00105                                                   {
00106     throw InvalidArgument("This is not an int vector-option");
00107 }

std::string Option::getString ( ) const throw (InvalidArgument) [virtual, inherited]

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:

InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

Definition at line 93 of file Option.cpp.

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

00093                                                {
00094     throw InvalidArgument("This is not a string-option");
00095 }

const std::string & Option::getTypeName ( ) const throw () [virtual, inherited]

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

References Option::myTypeName.

Referenced by OptionsCont::printHelp().

00169                                   {
00170     return myTypeName;
00171 }

std::string Option_Bool::getValueString ( ) const throw (InvalidArgument) [virtual]

Returns the string-representation of the value.

If myValue is true, "true" is returned, "false" otherwise.

See also:: std::string Option::getValueString()

Returns:: The stored value encoded into a string

Reimplemented from Option.

Definition at line 402 of file Option.cpp.

References myValue.

00402                                                          {
00403     if (myValue) {
00404         return "true";
00405     }
00406     return "false";
00407 }

bool Option_Bool::isBool ( ) const throw () [virtual]

Returns true, the information whether the option is a bool option.

Returns true.

See also:: bool Option::isBool()

Returns:: true

Reimplemented from Option.

Definition at line 411 of file Option.cpp.

00411                                   {
00412     return true;
00413 }

bool Option::isDefault ( ) const throw () [virtual, inherited]

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

References Option::myHaveTheDefaultValue.

Referenced by OptionsCont::writeConfiguration().

00145                                 {
00146     return myHaveTheDefaultValue;
00147 }

bool Option::isFileName ( ) const throw () [virtual, inherited]

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

00151                                  {
00152     return false;
00153 }

bool Option::isSet ( ) const throw () [inherited]

returns the information whether this options holds a valid value

Returns:: Whether a value has been set

Definition at line 75 of file Option.cpp.

References Option::myAmSet.

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

00075                             {
00076     return myAmSet;
00077 }

bool Option::isWriteable ( ) const throw () [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 157 of file Option.cpp.

References Option::myAmWritable.

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

00157                                   {
00158     return myAmWritable;
00159 }

bool Option::markSet ( ) throw () [protected, inherited]

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

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

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

00123                         {
00124     bool ret = myAmWritable;
00125     myHaveTheDefaultValue = false;
00126     myAmSet = true;
00127     myAmWritable = false;
00128     return ret;
00129 }

Option_Bool & Option_Bool::operator= ( const Option_Bool & s ) throw ()

Assignment operator.

Definition at line 378 of file Option.cpp.

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

00378                                                    {
00379     if (this==&s) {
00380         return *this;
00381     }
00382     Option::operator=(s);
00383     myValue = s.myValue;
00384     return *this;
00385 }

bool Option::set ( const std::string & v ) throw (InvalidArgument) [virtual, inherited]

Stores the given value (used for non-bool options).

This method is overriden by all option classes but Option_Bool. 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 defined in Option throws an exception, because all derived classes should override it - for Option_Bool, it is tested on a different position whether to use this method or bool set(bool).

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 being an instance of Option or Option_Bool or if the value could not be converted

Reimplemented in Option_Integer, Option_String, Option_Float, and Option_IntVector.

Definition at line 111 of file Option.cpp.

Referenced by OptionsCont::set().

00111                                                     {
00112     throw InvalidArgument("This is an abstract class.");
00113 }

bool Option_Bool::set ( bool v ) throw (InvalidArgument) [virtual]

sets the given value (converts it to bool)

Reimplemented from Option.

Definition at line 395 of file Option.cpp.

References Option::markSet(), and myValue.

00395                                               {
00396     myValue = v;
00397     return markSet();
00398 }

Friends And Related Function Documentation

friend class OptionsCont [friend, inherited]

OptionsCont is a friend class

Definition at line 217 of file Option.h.

Field Documentation

std::string Option::myTypeName [protected, inherited]

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

Definition at line 269 of file Option.h.

Referenced by Option::getTypeName(), Option_Bool(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), and Option_String::Option_String().

bool Option_Bool::myValue [private]

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

Definition at line 578 of file Option.h.

Referenced by getBool(), getValueString(), operator=(), Option_Bool(), and set().

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

Option_Bool Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation