blob: 500cea650ad0297d610e136c49ad8755d2d3421b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file sigmod/EggGroup.h
*/
#ifndef SIGMOD_EGGGROUP
#define SIGMOD_EGGGROUP
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::EggGroup EggGroup.h sigmod/EggGroup.h
* \brief A group of species that can breed with each other.
*/
class SIGMOD_EXPORT EggGroup : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param eggGroup The group to copy.
*/
EggGroup(const EggGroup& eggGroup);
/**
* Create a new egg group belonging to \p parent and id \p id.
*
* \param parent The parent of the group.
* \param id The id number for the group.
*/
EggGroup(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p eggGroup as a child of \p parent with id \p id.
*
* \param eggGroup The group to copy the data from.
* \param parent The parent of the group.
* \param id The id number for the group.
*/
EggGroup(const EggGroup& eggGroup, const Game* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the group.
* \param id The id number for the group.
*/
EggGroup(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the group's values are valid.
*/
void validate();
/**
* Load data from XML.
*
* \param xml The XML structure to extract data from.
*/
void load(const QDomElement& xml);
/**
* Get the data for the group in XML format.
*
* \return The XML structure representing the group.
*/
QDomElement save() const;
/**
* Sets the name of the egg group. This is only used internally.
*
* \param name The name of the group.
*/
void setName(const QString& name);
/**
* \sa setName
*
* \return The name of the group.
*/
QString name() const;
bool nameCheck(const QString& name) const;
EggGroup& operator=(const EggGroup& rhs);
private:
QString m_name;
};
}
#endif
|
