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