summaryrefslogtreecommitdiff
path: root/src/linkmessage.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/linkmessage.h')
-rw-r--r--src/linkmessage.h59
1 files changed, 31 insertions, 28 deletions
diff --git a/src/linkmessage.h b/src/linkmessage.h
index 6cdfb2f..baa22a6 100644
--- a/src/linkmessage.h
+++ b/src/linkmessage.h
@@ -1,39 +1,42 @@
1/**\file linkmessage.h 1/**\file linkmessage.h
2 */ 2 */
3 3
4#ifndef LINKMESSAGE_H 4#ifndef BU_LINKMESSAGE_H
5#define LINKMESSAGE_H 5#define BU_LINKMESSAGE_H
6 6
7/** 7namespace Bu
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 */
13class LinkMessage
14{ 8{
15public:
16 /** 9 /**
17 * Construct a blank LinkMessage. 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
18 */ 14 */
19 LinkMessage() {}; 15 class LinkMessage
16 {
17 public:
18 /**
19 * Construct a blank LinkMessage.
20 */
21 LinkMessage() {};
20 22
21 /** 23 /**
22 * Deconstruct a LinkMessage. 24 * Deconstruct a LinkMessage.
23 */ 25 */
24 virtual ~LinkMessage(); 26 virtual ~LinkMessage();
25 27
26 /** 28 /**
27 * Create a LinkMessage object with a specific message assosiated with it 29 * Create a LinkMessage object with a specific message assosiated with it
28 * to start with. 30 * to start with.
29 *@param nNewMsg The message to use in the Message object. 31 *@param nNewMsg The message to use in the Message object.
30 */ 32 */
31 LinkMessage( int nNewMsg ); 33 LinkMessage( int nNewMsg );
32 34
33 /** 35 /**
34 * The message contained in the Message object. 36 * The message contained in the Message object.
35 */ 37 */
36 int nMsg; 38 int nMsg;
37}; 39 };
40}
38 41
39#endif 42#endif