Diffstat (limited to 'include/sitecing/sitecing_interface.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | include/sitecing/sitecing_interface.h | 40 |
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 @@ +#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 */ |