OptionValue.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file OptionValue.cc
 *
 * Definitions of OptionValue classes.
 *
 * @author Jari Mäntyneva (jari.mantyneva-no.spam-tut.fi)
 * @note rating: red
 */
 
#include <iostream>
#include <string>
#include <sstream>
 
#include "Application.hh"
#include "OptionValue.hh"
 
using std::string;
using std::istringstream;
using std::endl;
 
//////////////////////////////////////////////////////////////////////////////
// OptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 */
OptionValue::OptionValue() {
}
 
/**
 * Destructor.
 */
OptionValue::~OptionValue() {
}
 
/**
 * This implementation should never be called.
 *
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setStringValue(const std::string&) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setIntegerValue(int) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setUnsignedIntegerValue(unsigned) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setRealValue(double) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setBoolValue(bool) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 */
void
OptionValue::setIntegerListValue(std::vector<int>) {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 * @exception OutOfRange Never thrown by this function.
 */
int
OptionValue::integerValue(int) const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return 0;
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 * @exception OutOfRange Never thrown by this function.
 */
std::string
OptionValue::stringValue(int) const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return "";
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 */
double
OptionValue::realValue() const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return 0;
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 */
bool
OptionValue::isFlagOn() const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return false;
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 */
bool
OptionValue::isFlagOff() const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return false;
}
 
/**
 * This implementation should never be called.
 *
 * @return Nothing.
 * @exception WrongSubclass Called for a wrong subclass.
 */
int
OptionValue::listSize() const {
    throw WrongSubclass(__FILE__, __LINE__, __func__);
    return 0;
}
 
//////////////////////////////////////////////////////////////////////////////
// IntegerOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The value of integer option.
 */
IntegerOptionValue::IntegerOptionValue(int value) {
    value_ = value;
}
 
/**
 * Destructor.
 */
IntegerOptionValue::~IntegerOptionValue() {
}
 
/**
 * Sets new value for integer option.
 *
 * @param value New value for the integer option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
IntegerOptionValue::setIntegerValue(int value) {
    value_ = value;
}
 
/**
 * Returns the value of integer option.
 *
 * @return The value of integer option.
 * @exception WrongSubclass Is never thrown by this function.
 * @exception OutOfRange Never thrown by this function.
 */
int
IntegerOptionValue::integerValue(int) const {
    return value_;
}
 
//////////////////////////////////////////////////////////////////////////////
// UnsignedIntegerOptionValue
//////////////////////////////////////////////////////////////////////////////
 
UnsignedIntegerOptionValue::UnsignedIntegerOptionValue(unsigned value) {
    value_ = value;
}
 
UnsignedIntegerOptionValue::~UnsignedIntegerOptionValue() {
}
 
void
UnsignedIntegerOptionValue::setUnsignedIntegerValue(unsigned value) {
    value_ = value;
}
 
unsigned
UnsignedIntegerOptionValue::unsignedIntegerValue(int) const {
    return value_;
}
 
//////////////////////////////////////////////////////////////////////////////
// StringOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The value of string option.
 */
StringOptionValue::StringOptionValue(const std::string value) {
    value_ = value;
}
 
/**
 * Destructor.
 */
StringOptionValue::~StringOptionValue() {
}
 
/**
 * Sets new value for string option.
 *
 * @param value New value for the string option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
StringOptionValue::setStringValue(const std::string& value) {
    value_ = value;
}
 
/**
 * Returns the value of string option.
 *
 * @return The value of string option.
 * @exception WrongSubclass Is never thrown by this function.
 * @exception OutOfRange Never thrown by this function.
 */
string
StringOptionValue::stringValue(int) const {
    return value_;
}
 
//////////////////////////////////////////////////////////////////////////////
// RealOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The value of real option.
 */
RealOptionValue::RealOptionValue(double value) {
    value_ = value;
}
 
/**
 * Destructor.
 */
RealOptionValue::~RealOptionValue() {
}
 
/**
 * Sets new value for real option.
 *
 * @param value New value for the real option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
RealOptionValue::setRealValue(double value) {
    value_ = value;
}
 
/**
 * Returns the value of string option.
 *
 * @return The value of string option.
 * @exception WrongSubclass Is never thrown by this function.
 */
double
RealOptionValue::realValue() const {
    return value_;
}
 
//////////////////////////////////////////////////////////////////////////////
// BoolOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The value of boolean option.
 */
BoolOptionValue::BoolOptionValue(bool value) {
    value_ = value;
}
 
/**
 * Destructor.
 */
BoolOptionValue::~BoolOptionValue() {
}
 
/**
 * Sets new value for boolean option.
 *
 * @param value New value for the boolean option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
BoolOptionValue::setBoolValue(bool value) {
    value_ = value;
}
 
/**
 * Returns the value of boolean option.
 *
 * @return The value of boolean option.
 * @exception WrongSubclass Is never thrown by this function.
 */
bool
BoolOptionValue::isFlagOn() const {
    return value_;
}
 
/**
 * Returns the negative value of boolean option.
 *
 * @return The negative value of boolean option.
 * @exception WrongSubclass Is never thrown by this function.
 */
bool
BoolOptionValue::isFlagOff() const {
    return !value_;
}
 
//////////////////////////////////////////////////////////////////////////////
// IntegerListOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The values of integer list options.
 */
IntegerListOptionValue::IntegerListOptionValue(std::vector<int> values) {
    values_ = values;
}
 
/**
 * Destructor.
 */
IntegerListOptionValue::~IntegerListOptionValue() {
}
 
/**
 * Sets new value for integer list option.
 *
 * @param value New value for the integer list option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
IntegerListOptionValue::setIntegerListValue(std::vector<int> values) {
    values_ = values;
}
 
/**
 * Returns the value from the given index of integer list.
 *
 * The index must be given between 0 and the size of value vector - 1
 *
 * @return The value from the given index of integer list.
 * @exception WrongSubclass Is never thrown by this function.
 * @exception OutOfRange If the index is out of the range.
 */
int
IntegerListOptionValue::integerValue(int index) const {
    if (index < 0 || static_cast<unsigned>(index) > values_.size() - 1) {
    string procName = "IntegerListOptionValue::integerValue";
    throw OutOfRange(__FILE__, __LINE__, procName);
    }
    return values_[index];
}
 
/**
 * Returns the size of the integer list.
 *
 * @return Size of hte list.
 */
int
IntegerListOptionValue::listSize() const {
    return values_.size();
}
 
//////////////////////////////////////////////////////////////////////////////
// StringListOptionValue
//////////////////////////////////////////////////////////////////////////////
 
/**
 * Constructor.
 *
 * @param value The values of string list options.
 */
StringListOptionValue::StringListOptionValue(std::vector<string> values) {
    values_ = values;
}
 
/**
 * Destructor.
 */
StringListOptionValue::~StringListOptionValue() {
}
 
/**
 * Sets new value for string list option.
 *
 * @param value New value for the string list option.
 * @exception WrongSubclass Is never thrown by this function.
 */
void
StringListOptionValue::setStringListValue(std::vector<string> values) {
    values_ = values;
}
 
/**
 * Returns the value from the given index of string list.
 *
 * The index must be given between 0 and the size of value vector - 1
 *
 * @return The value from the given index of string list.
 * @exception WrongSubclass Is never thrown by this function.
 * @exception OutOfRange If the index is out of the range.
 */
std::string
StringListOptionValue::stringValue(int index) const {
    if (index < 0 || static_cast<unsigned>(index) > values_.size() - 1) {
        string procName = "StringListOptionValue::stringValue";
        throw OutOfRange(__FILE__, __LINE__, procName);
    }
    return values_[index];
}
 
/**
 * Returns the size of the string list.
 *
 * @return Size of hte list.
 */
int
StringListOptionValue::listSize() const {
    return values_.size();
}