summaryrefslogtreecommitdiffabout
path: root/include/sitecing/sitecing_interface.h
Unidiff
Diffstat (limited to 'include/sitecing/sitecing_interface.h') (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/sitecing_interface.h40
1 files changed, 40 insertions, 0 deletions
diff --git a/include/sitecing/sitecing_interface.h b/include/sitecing/sitecing_interface.h
new file mode 100644
index 0000000..0cba2bb
--- a/dev/null
+++ b/include/sitecing/sitecing_interface.h
@@ -0,0 +1,40 @@
1#ifndef __SITECING_SITECING_INTERFACE_H
2#define __SITECING_SITECING_INTERFACE_H
3
4#include <ostream>
5
6/**
7 * @file
8 * @brief The sitecing_interface call declaration.
9 */
10
11namespace sitecing {
12 using namespace std;
13
14 /**
15 * @brief the interface to site-C-ing.
16 *
17 * The basic class used to convey communications between the component and
18 * the sitecing core.
19 */
20 class sitecing_interface {
21 public:
22 /**
23 * Pointer to the output stream.
24 */
25 ostream *out;
26
27 /**
28 * The default constructor doesn't do much.
29 */
30 sitecing_interface() : out(0) {}
31 /**
32 * The constructor initializes the output stream pointer.
33 * @param o the value to initialize the output stream pointer with.
34 */
35 sitecing_interface(ostream* o) : out(o) {}
36 };
37
38}
39
40#endif /* __SITECING_SITECING_INTERFACE_H */