-
Notifications
You must be signed in to change notification settings - Fork 0
/
ienvironmental.hpp
36 lines (32 loc) · 973 Bytes
/
ienvironmental.hpp
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
/******************************************************************************
* GRIDGEN: Grid Generating Compiler
* By: Andy Stone (aistone@gmail.com)
* (C) Copyright 2012 Colorado State University
*****************************************************************************/
/** \addtogroup Environmental
* @{
*/
#ifndef IENVIRONMENTAL_HPP_
#define IENVIRONMENTAL_HPP_
#include <string>
class Environment;
/**
* Environmental objects are objects that may be instantiated from an
* environment and have an associated identifier. Environmental objects
* are responsible for containing their identifier.
*
* Classes of type IEnvironmental should friend Environment.
*/
class IEnvironmental {
public:
// =======================
// - [Accessors] -
// =======================
/** @name Accessors */
///@{
/** Return the identifier for this object. */
virtual std::string getID() const = 0;
///@}
};
#endif
/** @}*/