summaryrefslogtreecommitdiffabout
path: root/include/sitecing/sitecing_interface.h
blob: 0cba2bbfac80bf30328ac18bf9ed8e3fcd14a74b (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
#ifndef __SITECING_SITECING_INTERFACE_H
#define __SITECING_SITECING_INTERFACE_H

#include <ostream>

/**
 * @file
 * @brief The sitecing_interface call declaration.
 */

namespace sitecing {
    using namespace std;

    /**
     * @brief the interface to site-C-ing.
     *
     * The basic class used to convey communications between the component and
     * the sitecing core.
     */
    class sitecing_interface {
	public:
	    /**
	     * Pointer to the output stream.
	     */
	    ostream *out;

	    /**
	     * The default constructor doesn't do much.
	     */
	    sitecing_interface() : out(0) {}
	    /**
	     * The constructor initializes the output stream pointer.
	     * @param o the value to initialize the output stream pointer with.
	     */
	    sitecing_interface(ostream* o) : out(o) {}
    };

}

#endif /* __SITECING_SITECING_INTERFACE_H */