key.hh

00001 // Copyright (C) 2004  EPITA Research and Development Laboratory
00002 //
00003 // This file is part of the Olena Library.  This library is free
00004 // software; you can redistribute it and/or modify it under the terms
00005 // of the GNU General Public License version 2 as published by the
00006 // Free Software Foundation.
00007 //
00008 // This library is distributed in the hope that it will be useful,
00009 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 // General Public License for more details.
00012 //
00013 // You should have received a copy of the GNU General Public License
00014 // along with this library; see the file COPYING.  If not, write to
00015 // the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00016 // Boston, MA 02110-1301, USA.
00017 //
00018 // As a special exception, you may use this file as part of a free
00019 // software library without restriction.  Specifically, if other files
00020 // instantiate templates or use macros or inline functions from this
00021 // file, or you compile this file and link it with other files to
00022 // produce an executable, this file does not by itself cause the
00023 // resulting executable to be covered by the GNU General Public
00024 // License.  This exception does not however invalidate any other
00025 // reasons why the executable file might be covered by the GNU General
00026 // Public License.
00027 
00028 #ifndef OLENA_OLN_UTILS_KEY_HH
00029 # define OLENA_OLN_UTILS_KEY_HH
00030 # include <ntg/all.hh>
00031 # include <vector>
00032 # include <iostream>
00033 
00034 namespace oln {
00035   namespace utils {
00041     class key
00042     {
00043     public:
00044       typedef ntg::int_u8       value_type; 
00045 
00052       explicit key(const std::vector<value_type> &data);
00053 
00060       explicit key(const value_type *data);
00061 
00071       value_type &operator[](unsigned i);
00072 
00082       const value_type &operator[](unsigned i) const;
00083 
00089       bool operator ==(const key &k);
00090 
00096       bool operator !=(const key &k);
00097 
00104       friend std::ostream &operator<<(std::ostream &stream, const key &k)
00105       {
00106         stream << "{";
00107         for (unsigned i = 0; i < 15; ++i)
00108           stream << "0x" << std::hex << k[i] << ", ";
00109         stream << "0x" << std::hex << k[15] << "}";
00110         return stream;
00111       }
00112 
00113 
00114     protected:
00115       value_type        data_[16]; 
00116     };
00117 
00118 # include <oln/utils/key.hxx>
00119 
00120   } // !utils
00121 } // !oln
00122 #endif // !OLENA_OLN_UTILS_KEY_HH

Generated on Tue Feb 20 20:20:07 2007 for Olena by  doxygen 1.5.1