src/meshTools/indexedOctree/labelBits.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::labelBits
  27
  28 Description
  29     A 29bits label and 3bits direction packed into single label
  30
  31 SourceFiles
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef labelBits_H
  36 #define labelBits_H
  37
  38 #include <OpenFOAM/label.H>
  39 #include <OpenFOAM/uLabel.H>
  40 #include <OpenFOAM/direction.H>
  41 #include <OpenFOAM/error.H>
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48
  49 /*---------------------------------------------------------------------------*\
  50                          Class labelBits Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class labelBits
  54 {
  55     // Private data
  56
  57         label data_;
  58
  59         inline static label pack(const label val, const direction bits)
  60         {
  61 #           ifdef FULLDEBUG
  62             if (bits > 7 || (((val<<3)>>3) != val))
  63             {
  64                 FatalErrorIn
  65                 (
  66                     "labelBits::pack(const label, const direction)"
  67                 )   << "Direction " << bits << " outside range 0..7"
  68                     << abort(FatalError);
  69             }
  70 #           endif
  71
  72             return (val<<3) | bits;
  73         }
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Construct null
  80         inline labelBits()
  81         {}
  82
  83         //- Construct from components
  84         inline labelBits(const label val, const direction bits)
  85         :
  86              data_(pack(val, bits))
  87         {}
  88
  89         //- Construct from Istream
  90         inline labelBits(Istream& is)
  91         {
  92             is >> data_;
  93         }
  94
  95
  96
  97     // Member Functions
  98
  99         inline label val() const
 100         {
 101             return data_ >> 3;
 102         }
 103
 104         inline direction bits() const
 105         {
 106             return data_ & 7;
 107         }
 108
 109         inline void setVal(const label val)
 110         {
 111             data_ = pack(val, bits());
 112         }
 113
 114         inline void setBits(const direction bits)
 115         {
 116             data_ = pack(val(), bits);
 117         }
 118
 119
 120     // Member Operators
 121
 122         friend inline bool operator==(const labelBits& a, const labelBits& b)
 123         {
 124             return a.data_ == b.data_;
 125         }
 126
 127         friend inline bool operator!=(const labelBits& a, const labelBits& b)
 128         {
 129             return !(a == b);
 130         }
 131
 132     // IOstream Operators
 133
 134         friend inline Istream& operator>>(Istream& is, labelBits& lb)
 135         {
 136             return is >> lb.data_;
 137         }
 138
 139         friend inline Ostream& operator<<(Ostream& os, const labelBits& lb)
 140         {
 141             return os << lb.data_;
 142         }
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************ vim: set sw=4 sts=4 et: ************************ //