TDME2
1.9.200
src
tdme
utilities
Enum.h
Go to the documentation of this file.
1
#pragma once
2
3
#include <string>
4
5
#include <
tdme/tdme.h
>
6
#include <
tdme/utilities/fwd-tdme.h
>
7
8
using
std::string;
9
10
/**
11
* Enum base class
12
* @author Andreas Drewke
13
*/
14
class
tdme::utilities::Enum
{
15
private
:
16
string
name
;
17
int
ordinal
;
18
19
public
:
20
/**
21
* Public constructor
22
* @param name name
23
* @param ordinal ordinal or index
24
*/
25
inline
Enum
(
const
string
&
name
,
int
ordinal
):
name
(
name
),
ordinal
(
ordinal
) {
26
}
27
28
/**
29
* Public denstructor
30
*/
31
inline
virtual
~Enum
() {
32
}
33
34
/**
35
* @return name
36
*/
37
inline
const
string
&
getName
()
const
{
38
return
name
;
39
}
40
41
/**
42
* @return ordinal or index
43
*/
44
inline
int
getOrdinal
()
const
{
45
return
ordinal
;
46
}
47
48
/**
49
* Compare enum with another enum
50
* @return equality
51
*/
52
inline
bool
equals
(
Enum
* enumObject)
const
{
53
return
this
== enumObject;
54
}
55
56
};
tdme::utilities::Enum
Enum base class.
Definition:
Enum.h:14
tdme::utilities::Enum::~Enum
virtual ~Enum()
Public denstructor.
Definition:
Enum.h:31
tdme::utilities::Enum::Enum
Enum(const string &name, int ordinal)
Public constructor.
Definition:
Enum.h:25
tdme::utilities::Enum::getName
const string & getName() const
Definition:
Enum.h:37
tdme::utilities::Enum::ordinal
int ordinal
Definition:
Enum.h:17
tdme::utilities::Enum::name
string name
Definition:
Enum.h:16
tdme::utilities::Enum::getOrdinal
int getOrdinal() const
Definition:
Enum.h:44
tdme::utilities::Enum::equals
bool equals(Enum *enumObject) const
Compare enum with another enum.
Definition:
Enum.h:52
tdme.h
fwd-tdme.h
Generated by
1.9.1