Nektar++
ConsistentObjectAccess.hpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ConsistentObjectAccess.hpp
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: A wrapper around objects or pointers to objects which give
33 // the same interface for both types (i.e., -> will work for both).
34 //
35 ///////////////////////////////////////////////////////////////////////////////
36 
37 #ifndef NEKTAR_LIB_UTILITIES_BASIC_UTILS_CONSISTENT_ACCESS_OBJECT_HPP
38 #define NEKTAR_LIB_UTILITIES_BASIC_UTILS_CONSISTENT_ACCESS_OBJECT_HPP
39 
40 #include <boost/shared_ptr.hpp>
41 #include <boost/call_traits.hpp>
42 #include <boost/type_traits.hpp>
44 
45 namespace Nektar
46 {
47  template<typename DataType>
49  {
50  static DataType& reference(DataType& o) { return o; }
51  static const DataType& const_reference(const DataType& o) { return o; }
52  static DataType* pointer(DataType& o) { return &o; }
53  static const DataType* const_pointer(const DataType& o) { return &o; }
54 
55  static bool ReferencesObject(const DataType& o) { return true; }
56  };
57 
58  template<typename DataType>
59  struct ConsistentObjectAccess<DataType*>
60  {
61  static const DataType& const_reference(DataType* o) { ASSERTL1(o != 0, "Can't dereference null pointer."); return *o; }
62  static const DataType* const_pointer(DataType* o) { return o; }
63  static bool ReferencesObject(DataType* o) { return o != 0; }
64 
65  static DataType& reference(DataType* o) { ASSERTL1(o != 0, "Can't dereference null pointer."); return *o; }
66  static DataType* pointer(DataType* o) { return o; }
67  };
68 
69 
70  template<typename DataType>
71  struct ConsistentObjectAccess<boost::shared_ptr<DataType> >
72  {
73  static const DataType& const_reference(const boost::shared_ptr<DataType>& o) { ASSERTL1(o, "Can't dereference null pointer."); return *o; }
74  static const DataType* const_pointer(const boost::shared_ptr<DataType>& o) { return o.get(); }
75  static DataType& reference(const boost::shared_ptr<DataType>& o) { ASSERTL1(o, "Can't dereference null pointer."); return *o; }
76  static DataType* pointer(const boost::shared_ptr<DataType>& o) { return o.get(); }
77  static bool ReferencesObject(const boost::shared_ptr<DataType>& o) { return o.get(); }
78  };
79 }
80 
81 #endif //NEKTAR_LIB_UTILITIES_BASIC_UTILS_CONSISTENT_ACCESS_OBJECT_HPP
82 
static bool ReferencesObject(const boost::shared_ptr< DataType > &o)
static DataType * pointer(DataType &o)
static const DataType & const_reference(const DataType &o)
static bool ReferencesObject(const DataType &o)
static const DataType & const_reference(DataType *o)
static const DataType * const_pointer(const boost::shared_ptr< DataType > &o)
static DataType & reference(DataType &o)
static const DataType * const_pointer(const DataType &o)
static const DataType * const_pointer(DataType *o)
static DataType & reference(const boost::shared_ptr< DataType > &o)
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode...
Definition: ErrorUtil.hpp:191
static DataType * pointer(const boost::shared_ptr< DataType > &o)
static const DataType & const_reference(const boost::shared_ptr< DataType > &o)