CostDBEntryKey.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 CostDBEntryKey.cc
 *
 * Implementation of CostDBEntryKey class.
 *
 * @author Tommi Rantanen 2003 (tommi.rantanen-no.spam-tut.fi)
 * @author Jari Mäntyneva 2005 (jari.mantyneva-no.spam-tut.fi)
 * @note rating: red
 */
 
#include "CostDBEntryKey.hh"
#include "Application.hh"
#include <iostream>
 
/**
 * Constructor.
 *
 * @param entryType Type of the entry key.
 */
CostDBEntryKey::CostDBEntryKey(const EntryKeyProperty* entryType) :
    type_(entryType) {
}
 
/**
 * Destructor.
 *
 * Deallocates memory reserved for the fields of the entry key.
 */
CostDBEntryKey::~CostDBEntryKey() {
    for (FieldTable::iterator i = fields_.begin(); i != fields_.end(); i++) {
        assert(*i != NULL);
        delete *i;
        *i = NULL;
    }
}
 
/**
 * Copies the entry key.
 *
 * Client is responsible of deallocating the memory reserved for the
 * returned object.
 *
 * @return A copy of the entry key.
 */
CostDBEntryKey*
CostDBEntryKey::copy() const {
 
    CostDBEntryKey* copy = new CostDBEntryKey(type_);
 
    for (FieldTable::const_iterator i = fields_.begin();
         i != fields_.end(); i++) {
 
        copy->addField(new EntryKeyField(*(*i)));
    }
    return copy;
}
 
/**
 * Adds certain field to the entry key.
 *
 * @param field A field to be added.
 * @exception ObjectAlreadyExists Equal field already exists.
 */
void
CostDBEntryKey::addField(EntryKeyField* field) {
    for (FieldTable::iterator i = fields_.begin(); i != fields_.end(); i++) {
        if ((*i)->type() == field->type()) {
            throw ObjectAlreadyExists(
                __FILE__, __LINE__, "CostDBEntryKey::addField");
        }
    }
    fields_.push_back(field);
}
 
/**
 * Replaces certain field of the entry key.
 *
 * @param newField A field.
 * @exception KeyNotFound Equal field was not found.
 */
void
CostDBEntryKey::replaceField(EntryKeyField* newField) {
    for (FieldTable::iterator i = fields_.begin(); i != fields_.end(); i++) {
        if ((*i)->type() == newField->type()) {
            delete *i;
            *i = newField;
            return;
        }
    }
    throw KeyNotFound(__FILE__, __LINE__, "CostDBEntry::replaceField");
}
 
/**
 * Returns demanded field of the entry key.
 *
 * @param fieldType Type of the field.
 * @exception KeyNotFound Requested field type was not found.
 */
EntryKeyField
CostDBEntryKey::keyFieldOfType(const EntryKeyFieldProperty& fieldType) const {
    for (FieldTable::const_iterator i = fields_.begin();
         i != fields_.end(); i++) {
        if ((*i)->type() == &fieldType) {
            return *(*i);
        }
    }
    throw KeyNotFound(__FILE__, __LINE__, "CostDBEntry::keyFieldOfType");
    return *fields_[0];// stupid return statement to make compiler quiet
}
 
/**
 * Returns demanded field of the entry key.
 *
 * @return type Type of the field.
 */
EntryKeyField
CostDBEntryKey::keyFieldOfType(std::string fieldType) const {
 
    return keyFieldOfType(*type_->fieldProperty(fieldType));
}
 
/**
 * Compares if two entry keys are equal.
 *
 * @param entryKey An entry key.
 * @return True if two entry keys are equal, otherwise false.
 */
bool
CostDBEntryKey::isEqual(const CostDBEntryKey& entryKey) const {
 
    if (type() == entryKey.type()) {
        bool isMatch = true;
        for (FieldTable::const_iterator f = fields_.begin();
             f != fields_.end(); f++) {
            
            if (!(*f)->isEqual(entryKey.keyFieldOfType(*(*f)->type()))) {
                isMatch = false;
                break;
            }
        }
        if (isMatch) {
            return true;
        }
    }
    return false;
}
 
/**
 * Returns the field found on the given index.
 *
 * The index must be between 0 and the number of fields - 1.
 *
 * @param index Index.
 * @return The field found on the given index.
 * @exception OutOfRange Index was out of range.
 */
const EntryKeyField&
CostDBEntryKey::field(int index) const {
    if (index >= fieldCount() || index < 0) {
        throw OutOfRange(__FILE__, __LINE__, "CostDBEntryKey::field");
    }
    return *fields_[index];
}