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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2008, 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 shareableobject.h
* \brief Deals with objects that can be shared from the
* calculation engine with the outside world.
*/
#ifndef __SHAREABLEOBJECT_H
#ifndef __DOXYGEN
#define __SHAREABLEOBJECT_H
#endif
#include <iostream>
#include <string>
#include "utilities/boostutils.h"
namespace regina {
/**
* \weakgroup engine
* @{
*/
/**
* Facilitates mirroring objects in the underlying C++ calculation
* engine using the various wrapper classes provided in the various
* external interfaces (such as the Python interface).
*
* In the underlying C++ engine, a ShareableObject is an object that can
* be shared with the outside world. In the external
* interfaces, a ShareableObject is a vacuous wrapper that allows access
* to the data and methods of the corresponding object in the underlying
* engine.
*
* See the various interface notes pages for more details regarding
* using classes derived from ShareableObject.
*/
class ShareableObject : public regina::boost::noncopyable {
public:
/**
* Default constructor that does nothing.
*
* \ifacespython Not present.
*/
ShareableObject();
/**
* Default destructor that does nothing.
*/
virtual ~ShareableObject();
/**
* Writes this object in short text format to the given output stream.
* The output should fit on a single line and no newline should
* be written.
*
* \ifacespython The parameter \a out does not exist;
* standard output will be used.
*
* @param out the output stream to which to write.
*/
virtual void writeTextShort(std::ostream& out) const = 0;
/**
* Writes this object in long text format to the given output
* stream. The output should provided the user with all the
* information they could want. The output should end with a
* newline.
*
* The default implementation of this routine merely calls
* writeTextShort() and adds a newline.
*
* \ifacespython The parameter \a out does not exist;
* standard output will be used.
*
* @param out the output stream to which to write.
*/
virtual void writeTextLong(std::ostream& out) const;
/**
* Returns the output from writeTextShort() as a string.
*
* \ifacespython This implements the <tt>__str__()</tt> function.
*
* @return a short text representation of this object.
*/
std::string toString() const;
/**
* Returns the output from writeTextLong() as a string.
*
* @return a long text representation of this object.
*/
std::string toStringLong() const;
};
/*@}*/
// Inline functions for ShareableObject
inline ShareableObject::ShareableObject() {
}
inline ShareableObject::~ShareableObject() {
}
inline void ShareableObject::writeTextLong(std::ostream& out) const {
writeTextShort(out);
out << '\n';
}
} // namespace regina
#endif
|
