summaryrefslogtreecommitdiff
path: root/cesar/maximus/system/inc/Station.h
blob: 1f1b48b69cfe1c06388e3e7ce65c142ba0d9dc0c (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
/************************************************************************
                        Station.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/system/inc/Station.h
**************************************************************************/

#ifndef STATION_H
#define STATION_H

#include "system_types.h"
#include "sci_types.h"
#include "networkclock_types.h" // for 'Network_Clock_Tick'

#include <exception>
#include <string>
#include <iostream> // for 'cout', 'cerr', 'clog' and 'pid_t'

#define STATION_PIPE_PATH "/tmp"
#define STATION_PIPE_PREFIX	"station"
#define STATION_SOCK_PATH STATION_PIPE_PATH
#define STATION_SOCK_PREFIX	STATION_PIPE_PREFIX
#define STATION_WAIT_LOOP_NB 10
#define STATION_WAIT_TIMEOUT_MS 100
#define STATION_MAX_SOCK_BUFFER_SIZE (256*1024)

class StationConfiguration;


/**
  * class Station
  */

class Station
{

public:

  // public attributes
  //  

private:

  // private attributes
  //  

  File_Descriptor mInputFileDescriptor, mOutputFileDescriptor;
  File_Descriptor mLogPipe;
  pid_t mPid;
  Station_Status mStationStatus;
  unsigned short int mStationIdleCounter;
  StationConfiguration * mpStationConfiguration;

protected:

  // protected attributes
  //  

public:

  // Constructors/Destructors
  //  

  /**
   * Constructor
   */
  Station ( const std::string & station_executable, const Network_Clock_Tick current_tick_value, uint32_t seed = 0 );

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

  // public methods
  //  

  bool operator== ( const Station & station ) const;

  Station & operator= ( const Station & station );

  /**
   * @return void
   */
  void displayStation ( ) const;

  bool launchDebugger ( const std::string & command_line ) const;

  // public attribute accessor methods
  //  

  // private attribute accessor methods
  //  

  /**
   * @return Sci_Station_Id
   */
  Sci_Msg_Station_Id getStationId ( ) const;

  /**
   * @return pid_t
   */
  pid_t getPid ( ) const;

  /**
   * @return bool
   * @param  input_file_descriptor
   */
  bool setInputFileDescriptor ( const File_Descriptor input_file_descriptor );

  /**
   * @return bool
   * @param  output_file_descriptor
   */
  bool setOutputFileDescriptor ( const File_Descriptor output_file_descriptor );

  /**
   * @return bool
   * @param  log_file_descriptor
   */
  bool setLogFileDescriptor ( const File_Descriptor log_file_descriptor );

  /**
   * @return File_Descriptor
   */
  File_Descriptor getInputFileDescriptor ( ) const;

  /**
   * @return File_Descriptor
   */
  File_Descriptor getOutputFileDescriptor ( ) const;

  /**
   * @return File_Descriptor
   */
  File_Descriptor getLogFileDescriptor ( ) const;

  /**
   * @return Station_Status
   */
  Station_Status getStationStatus ( ) const;

  /**
   * @return bool
   * @param  status
   */
  bool setStationStatus ( const Station_Status status );

  /**
   * @return mStationIdleCounter
   */
  unsigned short int getStationIdleCounter ( ) const;

  /**
   * @return bool
   */
  bool incrementStationIdleCounter ( );

  /**
   * @return bool
   */
  bool decrementStationIdleCounter ( );

  /**
   * @return bool
   * @param  p_station_configuration
   */
  bool setStationConfiguration ( StationConfiguration * p_station_configuration );

  /**
   * @return StationConfiguration
   */
  StationConfiguration * getStationConfiguration ( ) const;

  /**
   * @return bool
   * @param  station_name the new value of mpStationConfiguration->mStationName
   */
  bool setStationName ( const std::string & station_name );

  // protected attribute accessor methods
  //  

private:

  // private methods
  //  

  /**
   * @return void
   */
  void startProcess ( const Network_Clock_Tick current_tick_value, uint32_t seed = 0 );

  /**
   * @return void
   */
  void stopProcess ( );

  void initAttributes ( );

  void displayStationStatus ( ) const;

protected:

  // protected methods
  //  

};


#endif // STATION_H