ReferenceKey.icc

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 ReferenceKey.icc
 *
 * Inline and template functions for ReferenceKey classes.
 *
 * @author Pekka Jääskeläinen 2003 (pjaaskel-no.spam-cs.tut.fi)
 * @note reviewed 17 Oct 2003 by am, rm, kl
 *
 * @note rating: yellow
 */
 
namespace TPEF {
namespace ReferenceManager {
///////////////////////////////////////////////////////////////////////////////
// SectionIndexKey
///////////////////////////////////////////////////////////////////////////////
 
/**
 * Returns the section identification code for this key.
 *
 * @return Section identification code.
 */
inline SectionId
SectionIndexKey::sectionId() const {
    return sectionId_;
}
 
/**
 * Returns the index this key is set to.
 *
 * @return Index.
 */
inline SectionIndex
SectionIndexKey::index() const {
    return index_;
}
 
/**
 * Equality operator for SectionIndexKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys have same data.
 */
inline bool
SectionIndexKey::operator==(const SectionIndexKey& other) const {
    return sectionId_ == other.sectionId_ && index_ == other.index_;
}
 
/**
 * Inequality operator for SectionIndexKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionIndexKey::operator!=(const SectionIndexKey& other) const {
    return !(*this == other);
}
 
/**
 * Smaller than operator for SectionIndexKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionIndexKey::operator<(const SectionIndexKey& other) const {
    return (sectionId_ < other.sectionId_) ||
            (sectionId_ == other.sectionId_ &&
             index_ < other.index_);
}
 
///////////////////////////////////////////////////////////////////////////////
// SectionOffsetKey
///////////////////////////////////////////////////////////////////////////////
 
/**
 * Returns the section identification code for this key.
 *
 * @return Section identification code.
 */
inline SectionId
SectionOffsetKey::sectionId() const {
    return sectionId_;
}
 
/**
 * Returns the offset this key is set to.
 *
 * @return Offset.
 */
inline SectionOffset
SectionOffsetKey::offset() const {
    return offset_;
}
 
/**
 * Equality operator for SectionOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys have same data.
 */
inline bool
SectionOffsetKey::operator==(const SectionOffsetKey& other) const {
    return sectionId_ == other.sectionId_ && offset_ == other.offset_;
}
 
/**
 * Inequality operator for SectionOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionOffsetKey::operator!=(const SectionOffsetKey& other) const {
    return !(*this == other);
}
 
/**
 * Smaller than operator for SectionOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionOffsetKey::operator<(const SectionOffsetKey& other) const {
    return (sectionId_ < other.sectionId_) ||
        (sectionId_ == other.sectionId_ &&
         offset_ < other.offset_);
}
 
///////////////////////////////////////////////////////////////////////////////
// FileOffsetKey
///////////////////////////////////////////////////////////////////////////////
 
/**
 * Returns the file offset this key is set to.
 *
 * @return File offset.
 */
inline FileOffset
FileOffsetKey::fileOffset() const {
    return fileOffset_;
}
 
/**
 * Equality operator for FileOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys have same data.
 */
inline bool
FileOffsetKey::operator==(const FileOffsetKey& other) const {
    return fileOffset_ == other.fileOffset_;
}
 
/**
 * Inequality operator for FileOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
FileOffsetKey::operator!=(const FileOffsetKey& other) const {
    return !(*this == other);
}
 
/**
 * Smaller than operator for FileOffsetKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
FileOffsetKey::operator<(const FileOffsetKey& other) const {
    return (fileOffset_ < other.fileOffset_);
}
 
///////////////////////////////////////////////////////////////////////////////
// SectionKey
///////////////////////////////////////////////////////////////////////////////
 
/**
 * Returns the section identification code for this key.
 *
 * @return Section identification code.
 */
inline SectionId
SectionKey::sectionId() const {
    return sectionId_;
}
 
/**
 * Equality operator for SectionKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys have same data.
 */
inline bool
SectionKey::operator==(const SectionKey& other) const {
    return sectionId_ == other.sectionId_;
}
 
/**
 * Inequality operator for SectionKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionKey::operator!=(const SectionKey& other) const {
    return !(*this == other);
}
 
/**
 * Smaller than operator for SectionKey.
 *
 * @param other Another key to compare to.
 * @return True if the keys don't have same data.
 */
inline bool
SectionKey::operator<(const SectionKey& other) const {
    return sectionId_ < other.sectionId_;
}
 
} // namespace ReferenceManager
 
}