Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DataIndex.H

Go to the documentation of this file.
00001 /*   _______              __
00002     / ___/ /  ___  __ _  / /  ___
00003    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00004    \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 // CHOMBO Copyright (c) 2000-2004, The Regents of the University of
00007 // California, through Lawrence Berkeley National Laboratory (subject to
00008 // receipt of any required approvals from U.S. Dept. of Energy).  All
00009 // rights reserved.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are met:
00013 //
00014 // (1) Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 // (2) Redistributions in binary form must reproduce the above copyright
00017 // notice, this list of conditions and the following disclaimer in the
00018 // documentation and/or other materials provided with the distribution.
00019 // (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
00020 // Dept. of Energy nor the names of its contributors may be used to endorse
00021 // or promote products derived from this software without specific prior
00022 // written permission.
00023 //
00024 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00026 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00027 // PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00028 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00029 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00030 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 //
00036 // You are under no obligation whatsoever to provide any bug fixes,
00037 // patches, or upgrades to the features, functionality or performance of
00038 // the source code ("Enhancements") to anyone; however, if you choose to
00039 // make your Enhancements available either publicly, or directly to
00040 // Lawrence Berkeley National Laboratory, without imposing a separate
00041 // written license agreement for such Enhancements, then you hereby grant
00042 // the following license: a non-exclusive, royalty-free perpetual license
00043 // to install, use, modify, prepare derivative works, incorporate into
00044 // other computer software, distribute, and sublicense such Enhancements or
00045 // derivative works thereof, in binary and source code form.
00046 //
00047 // TRADEMARKS. Product and company names mentioned herein may be the
00048 // trademarks of their respective owners.  Any rights not expressly granted
00049 // herein are reserved.
00050 //
00051 
00052 #ifndef _DATAINDEX_H_
00053 #define _DATAINDEX_H_
00054 
00055 #ifndef WRAPPER
00056 class BoxLayout;
00057 
00058 #include <cstdlib>
00059 
00060 class DataIterator;
00061 class LayoutIterator;
00062 
00063 #endif /* WRAPPER */
00064 
00066 class LayoutIndex
00067 {
00068 public:
00070   LayoutIndex();
00071 
00072   ~LayoutIndex()
00073   {}
00074 
00075   // default copy and assign should be fine.
00076 
00078   bool operator == (const LayoutIndex& a_rhs) const;
00079 
00080   bool eq(const LayoutIndex& a_rhs) const
00081   {
00082     return *this == a_rhs;
00083   }
00084 
00086   bool operator != (const LayoutIndex& a_rhs) const
00087   {
00088     return !(*this == a_rhs);
00089   }
00090 
00092   bool isNull() const;
00093 
00094   // not user function. breaks design encapsulation. method not intended for
00095   // users. The alternative is to make this class a friend of BoxLayoutData<T>,
00096   // which implicitly makes this class templated, which makes no bloody sense.
00097   // The behaviour of this method is undefined for users.  bvs
00098   int intCode() const;
00099 
00100 
00101 private:
00102   friend class DataIterator;
00103   friend class LayoutIterator;
00104   friend class BoxLayout;
00105   friend class DataIndex;
00106 
00107   int        m_index;
00108   const int* m_layoutIntPtr;
00109 
00110   LayoutIndex(int        a_index,
00111               const int* a_layoutID)
00112     :
00113     m_index(a_index),
00114     m_layoutIntPtr(a_layoutID)
00115   {}
00116 };
00117 
00118 class DataIndex : public LayoutIndex
00119 {
00120 public:
00121   explicit DataIndex(const LayoutIndex& a_promotion)
00122     :
00123     LayoutIndex(a_promotion)
00124   {}
00125 
00126   DataIndex()
00127     :
00128     LayoutIndex()
00129   {}
00130 
00131   ~DataIndex()
00132   {}
00133 
00134 
00135 private:
00136   friend class LayoutIterator;
00137   friend class DataIterator;
00138   friend class BoxLayout;
00139   friend class Copier;
00140 
00141   DataIndex(int        a_index,
00142             const int* a_layoutID)
00143     :
00144     LayoutIndex(a_index, a_layoutID)
00145   {}
00146 };
00147 
00148 #ifndef WRAPPER
00149 inline LayoutIndex::LayoutIndex()
00150   :
00151   m_index(0),
00152   m_layoutIntPtr(NULL)
00153 {}
00154 
00155 inline bool LayoutIndex::operator == (const LayoutIndex& a_rhs) const
00156 {
00157   return (m_index == a_rhs.m_index);
00158 }
00159 
00160 inline int LayoutIndex::intCode() const
00161 {
00162   return m_index;
00163 }
00164 
00165 inline bool LayoutIndex::isNull() const
00166 {
00167   return m_layoutIntPtr == NULL;
00168 }
00169 #endif
00170 
00171 #endif

Generated on Wed Jan 19 17:51:23 2005 for Chombo&INSwithParticles by doxygen1.2.16