iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Array2DHelpers.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_MEMORY_DETAILS_ARRAY2DHELPERS_H
37 #define INCLUDE_NRT_CORE_MEMORY_DETAILS_ARRAY2DHELPERS_H
38 
39 namespace nrt
40 {
41  // ######################################################################
42  struct Array2DBase
43  {
44  typedef Dims<int32> DimsType;
45  };
46 
47  // ######################################################################
48  namespace exception
49  {
50  // ######################################################################
51  class OutOfBoundsArray2DException : public nrt::exception::Exception
52  {
53  public:
54  OutOfBoundsArray2DException(nrt::Point2D<int> const & index, nrt::Dims<int32> const & d) throw();
55 
56  virtual ~OutOfBoundsArray2DException() throw();
57 
58  Point2D<int> const & index() const;
59 
60  Dims<int32> const & dims() const;
61 
62  private:
63  nrt::Point2D<int> itsIndex;
64  nrt::Dims<int32> itsDims;
65  std::string whatstring;
66  };
67 
68  // ######################################################################
69  class BadDimsArray2DException : public nrt::exception::Exception
70  {
71  public:
72  BadDimsArray2DException(nrt::Dims<int32> const & d) throw();
73 
74  virtual ~BadDimsArray2DException() throw();
75 
76  Dims<int32> const & dims() const;
77 
78  private:
79  nrt::Dims<int32> itsDims;
80  std::string whatstring;
81  };
82 
83  } //namespace exception
84 
85 } // namespace nrt
86 
87 #endif // INCLUDE_NRT_CORE_MEMORY_DETAILS_ARRAY2DHELPERS_H