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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2011, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* 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 2 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, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/* end stub */
/*! \file packet/ncontainer.h
* \brief Contains a packet whose entire life purpose is to contain
* other packets.
*/
#ifndef __NCONTAINER_H
#ifndef __DOXYGEN
#define __NCONTAINER_H
#endif
#include "regina-core.h"
#include "packet/npacket.h"
namespace regina {
class NXMLPacketReader;
/**
* \weakgroup packet
* @{
*/
/**
* A packet that simply contains other packets. Such
* a packet contains no real data.
*/
class REGINA_API NContainer : public NPacket {
public:
static const int packetType;
/**
* Default constructor.
*/
NContainer();
virtual int getPacketType() const;
virtual std::string getPacketTypeName() const;
virtual void writeTextShort(std::ostream& out) const;
static NXMLPacketReader* getXMLReader(NPacket* parent);
virtual void writePacket(NFile& out) const;
static NContainer* readPacket(NFile& in, NPacket* parent);
virtual bool dependsOnParent() const;
protected:
virtual NPacket* internalClonePacket(NPacket* parent) const;
virtual void writeXMLPacketData(std::ostream& out) const;
};
/*@}*/
// Inline functions for NContainer
inline NContainer::NContainer() {
}
inline void NContainer::writeTextShort(std::ostream& o) const {
o << "Container";
}
inline void NContainer::writePacket(NFile&) const {
}
inline bool NContainer::dependsOnParent() const {
return false;
}
inline NPacket* NContainer::internalClonePacket(NPacket*) const {
return new NContainer();
}
inline void NContainer::writeXMLPacketData(std::ostream&) const {
}
} // namespace regina
#endif
|
