EntryKeyField.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 EntryKeyField.cc
 *
 * Implementation of EntryKeyField 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 "EntryKeyField.hh"
#include "Application.hh"
 
 
/**
 * Constructor.
 *
 * @param fieldData Value of the field.
 * @param type Type of the field.
 */
EntryKeyField::EntryKeyField(
    EntryKeyData* fieldData,
    const EntryKeyFieldProperty* type):
    data_(fieldData), properties_(type) {
}
 
/**
 * Copy constructor.
 *
 * @param old A field.
 */
EntryKeyField::EntryKeyField(const EntryKeyField& old):
    data_(old.data_->copy()), properties_(old.properties_) {
}
 
/**
 * Destructor.
 *
 * Deallocates memory reserved for the value of the field.
 */
EntryKeyField::~EntryKeyField() {
    assert(data_ != NULL);
    delete data_;
    data_ = NULL;
}
 
/**
 * Assignment operator.
 *
 * @param old A field.
 * @return A copy of the field.
 */
EntryKeyField&
EntryKeyField::operator=(const EntryKeyField& old) {
    if (this != &old) {
    data_ = old.data_->copy();
    properties_ = old.properties_;
    }
    return *this;
}
 
/**
 * Checks if two fields are equal.
 *
 * @param field A field.
 * @return True if two integers are equal, otherwise false.
 */
bool
EntryKeyField::isEqual(const EntryKeyField& field) const {
    return data_->isEqual(field.data_);
}
 
/**
 * Checks if this field is greater than another field.
 *
 * @param field A field.
 * @return True if this field is greater than another field, otherwise false.
 */
bool
EntryKeyField::isGreater(const EntryKeyField& field) const {
    return data_->isGreater(field.data_);
}
 
/**
 * Checks if this field is smaller than another field.
 *
 * @param field A field.
 * @return True if this field is smaller than another field, otherwise false.
 */
bool
EntryKeyField::isSmaller(const EntryKeyField& field) const {
    return data_->isSmaller(field.data_);
}
 
/**
 * Returns the relative position between two fields.
 *
 * Returns the field's relative position to the first field compared
 * to the second. For example, if this field has value 14, the first
 * field has 10 and the second 20, relative position would be 0.4.
 *
 * @param field1 First field.
 * @param field2 Second field.
 * @return The relative position between two fields.
 */
double
EntryKeyField::coefficient(
    const EntryKeyField& field1,
    const EntryKeyField& field2) const {
 
    return data_->coefficient(field1.data_, field2.data_);
}
 
/**
 * Returns value of the field as a string.
 *
 * @return Value of the field as a string.
 */
std::string
EntryKeyField::toString() const {
    return data_->toString();
}