Option_String Class Reference

#include <Option.h>

Inheritance diagram for Option_String:

Option Option_FileName

Detailed Description

Definition at line 370 of file Option.h.


Public Member Functions

virtual 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.
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.
virtual bool isBool () const throw ()
 Returns 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_String & operator= (const Option_String &s) throw ()
 Assignment operator.
 Option_String (const Option_String &s) throw ()
 Copy constructor.
 Option_String (const std::string &value, std::string typeName="STR") throw ()
 Constructor for an option with a default value.
 Option_String () throw ()
 Constructor for an option with no default value.
virtual bool set (bool v) throw (InvalidArgument)
 Sets the value (used for bool options).
bool set (const std::string &v) throw (InvalidArgument)
 Stores the given value.
virtual ~Option_String () 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).
std::string myValue

Friends

class OptionsCont

Constructor & Destructor Documentation

Option_String::Option_String (  )  throw ()

Constructor for an option with no default value.

Calls Option(false)

Definition at line 239 of file Option.cpp.

References Option::myTypeName.

00240         : Option() {
00241     myTypeName = "STR";
00242 }

Option_String::Option_String ( const std::string &  value,
std::string  typeName = "STR" 
) throw ()

Constructor for an option with a default value.

Calls Option(true)

Parameters:
[in] value This option's default value

Definition at line 245 of file Option.cpp.

References Option::myTypeName.

00246         : Option(true), myValue(value) {
00247     myTypeName = typeName;
00248 }

Option_String::Option_String ( const Option_String &  s  )  throw ()

Copy constructor.

Definition at line 254 of file Option.cpp.

References myValue.

00255         : Option(s) {
00256     myValue = s.myValue;
00257 }

Option_String::~Option_String (  )  throw () [virtual]

Destructor.

Definition at line 251 of file Option.cpp.

00251 {}

Member Function Documentation

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

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

Referenced by OptionsCont::getBool().

00099                                              {
00100     throw InvalidArgument("This is not a bool-option");
00101 }

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_String::getString (  )  const throw (InvalidArgument) [virtual]

Returns the stored string value.

See also:
std::string Option::getString()
Returns:
Returns the stored string

Reimplemented from Option.

Definition at line 272 of file Option.cpp.

References myValue.

00272                                                       {
00273     return myValue;
00274 }

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_String::getValueString (  )  const throw (InvalidArgument) [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

Reimplemented from Option.

Definition at line 285 of file Option.cpp.

References myValue.

00285                                                            {
00286     return myValue;
00287 }

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

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

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

00139                              {
00140     return false;
00141 }

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(), Option_Bool::set(), Option_Float::set(), set(), and Option_Integer::set().

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

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

Assignment operator.

Definition at line 261 of file Option.cpp.

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

Referenced by Option_FileName::operator=().

00261                                                        {
00262     if (this==&s) {
00263         return *this;
00264     }
00265     Option::operator=(s);
00266     myValue = s.myValue;
00267     return *this;
00268 }

bool Option::set ( bool  v  )  throw (InvalidArgument) [virtual, inherited]

Sets the value (used for bool options).

Returns:
Whether the new value could be set

Reimplemented in Option_Bool.

Definition at line 117 of file Option.cpp.

00117                                        {
00118     throw InvalidArgument("This is not a bool-option.");
00119 }

bool Option_String::set ( const std::string &  v  )  throw (InvalidArgument) [virtual]

Stores the given value.

The value is 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").

See also:
bool Option::set(std::string v)
Returns:
Whether the new value could be set

Reimplemented from Option.

Definition at line 278 of file Option.cpp.

References Option::markSet(), and myValue.

00278                                                             {
00279     myValue = v;
00280     return markSet();
00281 }

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_Bool(), Option_FileName::Option_FileName(), Option_Float::Option_Float(), Option_Integer::Option_Integer(), Option_IntVector::Option_IntVector(), and Option_String().

std::string Option_String::myValue [protected]

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

Definition at line 433 of file Option.h.

Referenced by getString(), getValueString(), operator=(), Option_String(), and set().

The documentation for this class was generated from the following files:
Generated on Wed May 5 00:06:57 2010 for Sumo - Simulation of Urban MObility by  doxygen 1.5.6