summaryrefslogtreecommitdiff
path: root/maximus/networkclock/inc/NetworkClockEvt.h
blob: 11efcc9432eaef6cf650c95820500f6eb265efb2 (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/************************************************************************
                        NetworkClockEvt.h - Copyright buret

Here you can write a license for your code, some comments or any other
information you want to have in your generated code. To to this simply
configure the "headings" directory in uml to point to a directory
where you have your heading files.

or you can just replace the contents of this file with your own.
If you want to do this, this file is located at

/usr/share/apps/umbrello/headings/heading.h

-->Code Generators searches for heading files based on the file extension
   i.e. it will look for a file name ending in ".h" to include in C++ header
   files, and for a file name ending in ".java" to include in all generated
   java code.
   If you name the file "heading.<extension>", Code Generator will always
   choose this file even if there are other files with the same extension in the
   directory. If you name the file something else, it must be the only one with that
   extension in the directory to guarantee that Code Generator will choose it.

you can use variables in your heading files which are replaced at generation
time. possible variables are : author, date, time, filename and filepath.
just write %variable_name%

This file was generated on %date% at %time%
The original location of this file is /home/buret/eclipse/maximus/networkclock/inc/NetworkClockEvt.h
**************************************************************************/

#ifndef NETWORKCLOCKEVT_H
#define NETWORKCLOCKEVT_H

#include "networkclock_types.h"
#include "sci_types.h"

#include <iostream>
#include <string>


/**
  * class NetworkClockEvt
  */

class NetworkClockEvt
{

public:

  // public attributes
  //
  
private:

  // private attributes
  //
  
  Sci_Msg_Station_Id mStationId;
  Network_Clock_Type mNetworkClockType;
  Network_Clock_Id mNetworkClockId;
    
protected:

  // protected attributes
  //

public:

  // Constructors/Destructors
  //  

  /**
   * Empty Constructor
   */
  NetworkClockEvt ( );

  /**
   * Constructor
   */
  NetworkClockEvt ( const Sci_Msg_Station_Id station_id,
                    const Network_Clock_Type type,
                    const Network_Clock_Id id );
                      
  /**
   * Copy Constructors
   */
  NetworkClockEvt ( const NetworkClockEvt & evt );

  /**
   * Empty Destructor
   */
  virtual ~NetworkClockEvt ( );

  // public methods
  //  

  bool operator== ( const NetworkClockEvt & evt ) const;
     
  NetworkClockEvt & operator= ( const NetworkClockEvt & evt );
  
  void displayEvt ( ) const;

  // public attribute accessor methods
  //  

  // private attribute accessor methods
  //  

  /**
   * Set the value of mStationId
   * @return bool
   * @param  station_id the new value of mStationId
   */
  bool setStationId ( const Sci_Msg_Station_Id station_id );

  /**
   * Get the value of mStationId
   * @return the value of mStationId
   */
  Sci_Msg_Station_Id getStationId ( ) const;

  /**
   * Set the value of mNetworkClockType
   * @return bool
   * @param  type the new value of mNetworkClockType
   */
  bool setNetworkClockType ( const Network_Clock_Type type );

  /**
   * Get the value of mNetworkClockType
   * @return the value of mNetworkClockType
   */
  Network_Clock_Type getNetworkClockType ( ) const;

  /**
   * Set the value of mNetworkClockId
   * @return bool
   * @param  id the new value of mNetworkClockId
   */
  bool setNetworkClockId ( const Network_Clock_Id id );

  /**
   * Get the value of mNetworkClockId
   * @return the value of mNetworkClockId
   */
  Network_Clock_Id getNetworkClockId ( ) const;

  // protected attribute accessor methods
  //  

private:

  // private methods
  //  
  
  void initAttributes ( ) ;
  
  std::string getType ( ) const;

protected:

  // protected methods
  //  

};


#endif // NETWORKCLOCKEVT_H