summaryrefslogtreecommitdiff
path: root/src/linkmessage.h
blob: 6cdfb2f9d5b05d2ec7b6bbfe06db36e9bca3b615 (plain)
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
37
38
39
/**\file linkmessage.h
 */

#ifndef LINKMESSAGE_H
#define LINKMESSAGE_H

/**
 * A message to be broadcast accross ProgramLinks in a ProgramChain.  Generally
 * one would make a subclass of this in order to transmit more useful
 * information, but sometimes it isn't necesarry.
 *@author Mike Buland
 */
class LinkMessage
{
public:
	/**
	 * Construct a blank LinkMessage.
	 */
	LinkMessage() {};

	/**
	 * Deconstruct a LinkMessage.
	 */
	virtual ~LinkMessage();
	
	/**
	 * Create a LinkMessage object with a specific message assosiated with it
	 * to start with.
	 *@param nNewMsg The message to use in the Message object.
	 */
	LinkMessage( int nNewMsg );

	/**
	 * The message contained in the Message object.
	 */
	int nMsg;
};

#endif