Spinning Topp Logo BlackTopp Studios
inc
assetid.h
1 // © Copyright 2010 - 2016 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 _resourceassetid_h
41 #define _resourceassetid_h
42 
43 #include "datatypes.h"
44 
45 namespace Mezzanine
46 {
47  namespace Resource
48  {
49  ///////////////////////////////////////////////////////////////////////////////
50  /// @brief This is a simple class storing the name and group identification of an Asset/Stream.
51  /// @details
52  ///////////////////////////////////////
54  {
55  public:
56  ///////////////////////////////////////////////////////////////////////////////
57  // Public Data Members
58 
59  /// @brief A string containing the name of this Asset.
61  /// @brief A string containing the name of the group this Asset belongs to.
63 
64  ///////////////////////////////////////////////////////////////////////////////
65  // Construction and Destruction
66 
67  /// @brief Class constructor.
68  AssetID() { }
69  /// @brief Class destructor.
70  ~AssetID() { }
71 
72  ///////////////////////////////////////////////////////////////////////////////
73  // Operators
74 
75  /// @brief Less-than operator.
76  /// @param Other The other AssetID to compare with.
77  /// @return Returns true if this Asset should be order before the other Asset, false otherwise.
78  Boole operator<(const AssetID& Other)
79  {
80  if( this->GroupName == Other.GroupName ) {
81  return ( this->AssetName < Other.AssetName );
82  }else{
83  return ( this->GroupName < Other.GroupName );
84  }
85  }
86  /// @brief Greater-than operator.
87  /// @param Other The other AssetID to compare with.
88  /// @return Returns true if this Asset should be order after the other Asset, false otherwise.
89  Boole operator>(const AssetID& Other)
90  {
91  if( this->GroupName == Other.GroupName ) {
92  return ( this->AssetName > Other.AssetName );
93  }else{
94  return ( this->GroupName > Other.GroupName );
95  }
96  }
97 
98  /// @brief Equality operator.
99  /// @param Other The other AssetID to compare with.
100  /// @return Returns true if this Asset is the same as another asset, false otherwise.
101  Boole operator==(const AssetID& Other)
102  {
103  return ( this->GroupName == Other.GroupName ) && ( this->AssetName == Other.AssetName );
104  }
105  /// @brief Inequality operator.
106  /// @param Other The other AssetID to compare with.
107  /// @return Returns true if this Asset is not the same as another asset, false otherwise..
108  Boole operator!=(const AssetID& Other)
109  {
110  return ( this->GroupName != Other.GroupName ) || ( this->AssetName != Other.AssetName );
111  }
112  };//AssetID
113  }//Resource
114 }//Mezzanine
115 
116 #endif
AssetID()
Class constructor.
Definition: assetid.h:68
String GroupName
A string containing the name of the group this Asset belongs to.
Definition: assetid.h:62
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
~AssetID()
Class destructor.
Definition: assetid.h:70
String AssetName
A string containing the name of this Asset.
Definition: assetid.h:60
All the definitions for datatypes as well as some basic conversion functions are defined here...
Boole operator!=(const AssetID &Other)
Inequality operator.
Definition: assetid.h:108
This is a simple class storing the name and group identification of an Asset/Stream.
Definition: assetid.h:53
Boole operator<(const AssetID &Other)
Less-than operator.
Definition: assetid.h:78
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
Boole operator>(const AssetID &Other)
Greater-than operator.
Definition: assetid.h:89
Boole operator==(const AssetID &Other)
Equality operator.
Definition: assetid.h:101
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159