StringListOptionValue Class Reference

#include <OptionValue.hh>

Inheritance diagram for StringListOptionValue:

Collaboration diagram for StringListOptionValue:

Public Member Functions
	StringListOptionValue (std::vector< std::string > values)
virtual	~StringListOptionValue ()
virtual std::string	stringValue (int index=0) const
virtual int	listSize () const
virtual void	setStringListValue (std::vector< std::string > values)
Public Member Functions inherited from OptionValue
	OptionValue ()
virtual	~OptionValue ()
virtual void	setStringValue (const std::string &)
virtual void	setIntegerValue (int)
virtual void	setUnsignedIntegerValue (unsigned)
virtual void	setRealValue (double)
virtual void	setBoolValue (bool)
virtual void	setIntegerListValue (std::vector< int > values)
virtual int	integerValue (int index=0) const
virtual double	realValue () const
virtual bool	isFlagOn () const
virtual bool	isFlagOff () const

Private Member Functions
	StringListOptionValue (const StringListOptionValue &)
	Copying not allowed.
StringListOptionValue &	operator= (const StringListOptionValue &)
	Assignment not allowed.

Private Attributes
std::vector< std::string >	values_
	The value of option.

Detailed Description

OptionValue that has list of strings as value.

Definition at line 237 of file OptionValue.hh.

Constructor & Destructor Documentation

StringListOptionValue() [1/2]

StringListOptionValue::StringListOptionValue

(

std::vector< std::string >

values

)

Constructor.

Parameters

value

The values of string list options.

Definition at line 460 of file OptionValue.cc.

                                                                     {
    values_ = values;
}

References values_.

~StringListOptionValue()

StringListOptionValue::~StringListOptionValue ( )

virtual

Destructor.

Definition at line 467 of file OptionValue.cc.

                                              {
}

StringListOptionValue() [2/2]

StringListOptionValue::StringListOptionValue ( const StringListOptionValue &  )

private

Copying not allowed.

Member Function Documentation

listSize()

int StringListOptionValue::listSize ( ) const

virtual

Returns the size of the string list.

Returns

Size of hte list.

Reimplemented from OptionValue.

Definition at line 505 of file OptionValue.cc.

                                      {
    return values_.size();
}

References values_.

operator=()

StringListOptionValue & StringListOptionValue::operator= ( const StringListOptionValue &  )

private

Assignment not allowed.

setStringListValue()

void StringListOptionValue::setStringListValue ( std::vector< std::string >  values )

virtual

Sets new value for string list option.

Parameters

value

New value for the string list option.

Exceptions

WrongSubclass

Is never thrown by this function.

Definition at line 477 of file OptionValue.cc.

                                                                  {
    values_ = values;
}

References values_.

stringValue()

std::string StringListOptionValue::stringValue ( int  index = 0 ) const

virtual

Returns the value from the given index of string list.

The index must be given between 0 and the size of value vector - 1

Returns

The value from the given index of string list.

Exceptions

WrongSubclass	Is never thrown by this function.
OutOfRange	If the index is out of the range.

Reimplemented from OptionValue.

Definition at line 491 of file OptionValue.cc.

                                                  {
    if (index < 0 || static_cast<unsigned>(index) > values_.size() - 1) {
        string procName = "StringListOptionValue::stringValue";
        throw OutOfRange(__FILE__, __LINE__, procName);
    }
    return values_[index];
}

References values_.

Member Data Documentation

values_

std::vector<std::string> StringListOptionValue::values_

private

The value of option.

Definition at line 253 of file OptionValue.hh.

Referenced by listSize(), setStringListValue(), StringListOptionValue(), and stringValue().

---

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

• OptionValue.hh
• OptionValue.cc