diff options
Diffstat (limited to 'src/linkmessage.h')
-rw-r--r-- | src/linkmessage.h | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/src/linkmessage.h b/src/linkmessage.h new file mode 100644 index 0000000..6cdfb2f --- /dev/null +++ b/src/linkmessage.h | |||
@@ -0,0 +1,39 @@ | |||
1 | /**\file linkmessage.h | ||
2 | */ | ||
3 | |||
4 | #ifndef LINKMESSAGE_H | ||
5 | #define LINKMESSAGE_H | ||
6 | |||
7 | /** | ||
8 | * A message to be broadcast accross ProgramLinks in a ProgramChain. Generally | ||
9 | * one would make a subclass of this in order to transmit more useful | ||
10 | * information, but sometimes it isn't necesarry. | ||
11 | *@author Mike Buland | ||
12 | */ | ||
13 | class LinkMessage | ||
14 | { | ||
15 | public: | ||
16 | /** | ||
17 | * Construct a blank LinkMessage. | ||
18 | */ | ||
19 | LinkMessage() {}; | ||
20 | |||
21 | /** | ||
22 | * Deconstruct a LinkMessage. | ||
23 | */ | ||
24 | virtual ~LinkMessage(); | ||
25 | |||
26 | /** | ||
27 | * Create a LinkMessage object with a specific message assosiated with it | ||
28 | * to start with. | ||
29 | *@param nNewMsg The message to use in the Message object. | ||
30 | */ | ||
31 | LinkMessage( int nNewMsg ); | ||
32 | |||
33 | /** | ||
34 | * The message contained in the Message object. | ||
35 | */ | ||
36 | int nMsg; | ||
37 | }; | ||
38 | |||
39 | #endif | ||