MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
metacodekey.h
1 // © Copyright 2010 - 2012 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _inputmetacodekey_h
41 #define _inputmetacodekey_h
42 
43 #include "Input/metacode.h"
44 #include "exception.h"
45 
46 namespace Mezzanine
47 {
48  namespace Input
49  {
50  ///////////////////////////////////////////////////////////////////////////////
51  /// @class MetaCodeKey
52  /// @headerfile metacodekey.h
53  /// @brief A key class for MetaCodes to be used in associative containers.
54  /// @details
55  ///////////////////////////////////////
57  {
58  public:
59  /// @brief Convenience typedef for the compare method to be used by this key.
60  typedef Boolean (DeviceCompare)(const MetaCode& First, const MetaCode& Second);
61  protected:
62  /// @internal
63  /// @brief The metacode being used as the compare object.
64  const MetaCode MCode;
65  /// @internal
66  /// @brief The compare method being used for this key.
67  DeviceCompare* Compare;
68  public:
69  /// @brief Class constructor.
70  /// @param Code The MetaCode this key is to use for sorting.
71  MetaCodeKey(const MetaCode& Code);
72  /// @brief Copy constructor.
73  /// @param Other The other MetaCodeKey to copy.
74  MetaCodeKey(const MetaCodeKey& Other);
75  /// @brief Class destructor.
76  ~MetaCodeKey();
77 
78  ///////////////////////////////////////////////////////////////////////////////
79  // Utility
80 
81  /// @brief Gets the MetaCode this object is using for sorting.
82  /// @return Returns a const reference to the MetaCode stored by this object.
83  const MetaCode& GetKeyData() const;
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Operators
87 
88  /// @brief Less-than operator.
89  /// @param Other The other key to compare against.
90  /// @return Returns true if this key is less than another key.
91  Boolean operator<(const MetaCodeKey& Other) const;
92  };//MetaCodeKey
93  }//Input
94 }//Mezzanine
95 
96 #endif