summaryrefslogtreecommitdiff
path: root/maximus/networkclock/inc/NetworkClockProcessor.h
blob: d242105190314c2cafa25b5da433c5260cc5e8c4 (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/************************************************************************
                        NetworkClockProcessor.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/NetworkClockProcessor.h
**************************************************************************/

#ifndef NETWORKCLOCKPROCESSOR_H
#define NETWORKCLOCKPROCESSOR_H

#include "INetworkClock.h"

#include "networkclock_types.h"

class NetworkClockEvtList;
class NetworkClockEvt;
class ClockSciMsg;
class ISci;
class ISystem;
class IFunctionCall;
class IPhy;
class IEthernet;


/**
  * class NetworkClockProcessor
  */

class NetworkClockProcessor : public INetworkClock
{
  
public:

  // public attributes
  //  

private:

  // private attributes
  //  

  Network_Clock_Tick mCurrentTickValue;
  NetworkClockEvtList * mpNetworkClockEvtList;
  ISci * mpSciServer;
  ISystem * mpSystemManager;
  IFunctionCall * mpFunctionCallManager;
  IPhy * mpPhyProcessor;
  IEthernet * mpEthernet;

protected:

  // protected attributes
  //  

public:

  // Constructors/Destructors
  //  

  /**
   * Empty Constructor
   */
  NetworkClockProcessor ( );

  /**
   * Constructor
   */
  NetworkClockProcessor ( ISci * p_sci_server,
                          ISystem * p_system_manager,
                          IFunctionCall * p_function_call_manager,
                          IPhy * p_phy_processor,
                          IEthernet * p_ethernet );

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

  // public methods
  //  

  /**
   * @param  evt_to_send
   * @param  tick_value
   */
  void createEvt ( const Network_Clock_Tick tick_value, const NetworkClockEvt & evt_to_send );

  /**
   * @return bool
   * @param  evt_to_insert
   * @param  tick_value
   */
  bool insertEvt ( const Network_Clock_Tick tick_value, const NetworkClockEvt & evt_to_insert );

  /**
   * @return bool
   * @param  evt_to_remove
   * @param  tick_value
   */
  bool removeEvt ( const Network_Clock_Tick tick_value, const NetworkClockEvt & evt_to_remove );

  /**
   * @return bool
   * @param  station_id
   */
  bool removeEvts ( const Sci_Msg_Station_Id station_id );

  /**
   * @return bool
   */
  bool processNextEvt ( const Network_Clock_Tick max_tick_value = 0 );
  
  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtNone ( NetworkClockEvt & evt_to_process );

  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtRemove ( NetworkClockEvt & evt_to_process );  
  
  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtStation ( NetworkClockEvt & evt_to_process );

  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtFunctionCall ( NetworkClockEvt & evt_to_process );

  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtPhy ( NetworkClockEvt & evt_to_process );

  /**
   * @return bool
   * @param  evt_to_process
   */
  bool processEvtSystem ( NetworkClockEvt & evt_to_process );  

  /**
   * Processes an event of type ETHERNET.
   * @param  evt_to_process
   * @return bool
   */
  bool processEvtEthernet ( NetworkClockEvt & evt_to_process );  

  // public attribute accessor methods
  //  

  // private attribute accessor methods
  //  

  /**
   * @return Network_Clock_Tick
   */
  Network_Clock_Tick getCurrentTickValue ( ) const;
  
  /**
   * @return bool
   */
  bool setCurrentTickValue ( const Network_Clock_Tick tick_value );
  
   /**
   * @return the value of mpNetworkClockEvtList
   */
  NetworkClockEvtList * getNetworkClockEvtList ( );
  
  // protected attribute accessor methods
  //  

private:

  // private methods
  //  

  /**
   * @return bool
   * @param  clock_sci_msg_to_send
   */
  bool sendEvtMsg ( ClockSciMsg & clock_sci_msg_to_send );

  void initAttributes ( ) ;
  
  void registerClockSciMsg ( );

  /**
   * Gets a pointer to the PHY processor.
   * @return IPhy *
   */
  IPhy * getPhy ( ) const;

  /**
   * Gets a pointer to Ethernet.
   * @return mpEthernet
   */
  IEthernet * getEthernet ( ) const;

protected:

  // protected methods
  //  

};


#endif // NETWORKCLOCKPROCESSOR_H