Pyrogenesis  trunk
ICmpExample.h
Go to the documentation of this file.
1 /* Copyright (C) 2017 Wildfire Games.
2  * This file is part of 0 A.D.
3  *
4  * 0 A.D. is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * 0 A.D. is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef INCLUDED_ICMPEXAMPLE
19 #define INCLUDED_ICMPEXAMPLE
20 
22 
23 // ...any other forward declarations and includes you might need...
24 
25 /**
26  * Documentation to describe what this interface and its associated component types are
27  * for, and roughly how they should be used.
28  */
29 class ICmpExample : public IComponent
30 {
31 public:
32  /**
33  * Documentation for each method.
34  */
35  virtual int DoWhatever(int x, int y) = 0;
36 
37  // ...
38 
39  DECLARE_INTERFACE_TYPE(Example)
40 };
41 
42 #endif // INCLUDED_ICMPEXAMPLE
Definition: IComponent.h:33
virtual int DoWhatever(int x, int y)=0
Documentation for each method.
Documentation to describe what this interface and its associated component types are for...
Definition: ICmpExample.h:29
#define DECLARE_INTERFACE_TYPE(iname)
Definition: Interface.h:23