summaryrefslogtreecommitdiff
path: root/maximus/functioncall/inc/FunctionSciMsg.h
blob: 85c900945b776550a978cfe4d43dd4b82be303cf (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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/************************************************************************
                        FunctionSciMsg.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/functioncall/inc/FunctionSciMsg.h
**************************************************************************/

#ifndef FUNCTIONSCIMSG_H
#define FUNCTIONSCIMSG_H

#include "SciMsg.h"

#include "functioncall_types.h"
#include "sci_types.h"

#include <vector>
#include <string>
#include <ostream>

class IFunctionCall;
class FunctionCallParameter;

typedef std::vector<FunctionCallParameter> ParametersList; 


/**
 * class FunctionSciMsg
 */

class FunctionSciMsg : public SciMsg
{
  
public:

  // public attributes
  //  

private:

  // private attributes
  //  

  // Get from specialized SCI message header
  //
  Function_Call_Type mSpecializedSciMsgType;
  static Function_Call_Msg_Id mSpecializedSciMsgId; // to send to station
  Function_Call_Parameters_Number mSpecializedSciMsgParametersNumber;
  Function_Call_Flags mSpecializedSciMsgFlags;

  // Specialized SCI msg header
  //
  Function_Call_Header mSpecializedSciMsgHeader;
    
  // Unique string identifier for function call
  //
  std::string mFunctionName;
  
  // Function parameters
  //
  ParametersList mListOfParameters;

  IFunctionCall * mpFunctionCallManager;

protected:

  // protected attributes
  //  

public:

  // Constructors/Destructors
  //  

  /**
   * Constructor
   */
  FunctionSciMsg ( IFunctionCall * p_function_call_manager );

  /**
   * Copy Constructors
   */
  FunctionSciMsg ( const FunctionSciMsg & function_sci_msg );

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

  // public methods
  //  

  /**
   * @return SciMsg *
   */
  SciMsg * create ( ) const;

  /**
   * return bool
   */
  bool dispatchMsg ( );
 
  /**
   * @return bool
   */
  bool identifySpecializedSciMsgHeader ( );
  
  /**
   * @return bool
   */
  bool checkCompatibility ( ) const; 
  
  /**
   * @return bool
   * @param  function_argument_to_add
   */
  bool addParameter ( const FunctionCallParameter & function_argument_to_add );

  /**
   * @return bool
   * @param  name
   * Remove the parameter named name from the function SCI message.
   */
  bool removeParameter ( const std::string & name );

  /**
   * @return bool
   * @param  name_of_parameter_to_get
   * @param  p_data
   */
  bool bindParameter ( const std::string name_of_parameter_to_get, unsigned long & data_length, unsigned char * p_data ) const;

  /**
   * @return bool
   */
  bool identifyFunctionName ( );
  
  /**
   * @return bool
   */
  bool identifyParameters ( );

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

  void displaySpecializedSciMsgHeader ( ) const;

  /**
   * Display the specialized SCI message type.
   */
  void displaySpecializedSciMsgType ( int log_level ) const;

  // public attribute accessor methods
  //  
  
  // private attribute accessor methods
  //  
  
  /**
   * Get the value of mSpecializedSciMsgType
   * @return the value of mSpecializedSciMsgType
   */
  Function_Call_Type getSpecializedSciMsgType ( ) const;

  /**
   * Set the value of mSpecializedSciMsgType
   * @return bool
   * @param  type the new value of mSpecializedSciMsgType
   */
  bool setSpecializedSciMsgType ( const Function_Call_Type type );

  /**
   * Get the value of mSpecializedSciMsgHeader.msg_id
   * @return the value of mSpecializedSciMsgHeader.msg_id
   */
  Function_Call_Msg_Id getMsgId ( ) const;

  /**
   * Set the value of mSpecializedSciMsgHeader.msg_id
   * @return bool
   */
  bool setMsgId ( const Function_Call_Msg_Id msg_id );

  /**
   * Get the value of mSpecializedSciMsgId
   * @return the value of mSpecializedSciMsgId
   */
  Function_Call_Msg_Id getSpecializedSciMsgId ( ) const;

  /**
   * Increment the value of mSpecializedSciMsgId
   * @return bool
   */
  bool incrementSpecializedSciMsgId ( );

  /**
   * Get the value of mSpecializedSciMsgParametersNumber
   * @return the value of mSpecializedSciMsgParametersNumber
   */
  Function_Call_Parameters_Number getSpecializedSciMsgParametersNumber ( ) const;

  /**
   * Set the value of mSpecializedSciMsgParametersNumber
   * @return bool
   * @param  number_of_parameters the new value of mSpecializedSciMsgParametersNumber
   */
  bool setSpecializedSciMsgParametersNumber ( const Function_Call_Parameters_Number number_of_parameters );

  /**
   * Get the value of mSpecializedSciMsgFlags
   * @return the value of mSpecializedSciMsgFlags
   */
  Function_Call_Flags getSpecializedSciMsgFlags ( ) const;

  /**
   * Set the value of mSpecializedSciMsgFlags
   * @return bool
   * @param  flags the new value of mSpecializedSciMsgFlags
   */
  bool setSpecializedSciMsgFlags ( const Function_Call_Flags flags );

  /**
   * Set the value of mSpecializedSciMsgHeader.reserved
   * @return bool
   */
  bool setReserved ( const uint16_t reserved );

  /**
   * Get the value of mSpecializedSciMsgHeader
   * @return the value of mSpecializedSciMsgHeader into a void pointer
   */
  void * returnSpecializedSciMsgHeader ( ) const;

  /**
   * @return mSpecializedSciMsgHeader
   */
  const Function_Call_Header & getSpecializedSciMsgHeader ( ) const;
 
  /**
   * @return bool
   * @param  specialized_sci_msg_header the new value of mSpecializedSciMsgHeader
   */
  bool setSpecializedSciMsgHeader ( const Function_Call_Header & specialized_sci_msg_header );
 
  /**
   * Get the value of mFunctionName
   * @return the value of mFunctionName
   */
  std::string getFunctionName ( ) const;
  
  /**
   * Set the value of mFunctionName
   * @return bool
   * @param  name the new value of mFunctionName
   */
  bool setFunctionName ( const std::string name );

  /**
   * Get the value of mListOfParameters
   * @return the value of mListOfParameters
   */
  const ParametersList & getListOfParameters ( ) const;

  /**
   * Set the value of mListOfParameters
   * @return bool
   * @param  list_of_parameters the new value of mListOfParameters
   */
  bool setListOfParameters ( const ParametersList & list_of_parameters );

  /**
   * Get the value of mpFunctionCallManager
   * @return mpFunctionCallManager
   */
  IFunctionCall * getFunctionCallManager () const;

  /**
   * Set the value of mpFunctionCallManager
   * @return bool
   * @param  p_function_call_manager the new value of mpFunctionCallManager
   */
  bool setFunctionCallManager ( IFunctionCall * p_function_call_manager );

  // protected attribute accessor methods
  //  
  
private:

  // private methods
  //  

  void initAttributes ( );

  void displayFunctionName ( ) const;
 
  void displayParameter ( unsigned int parameter_iterator ) const;

  void displayListOfParameters ( ) const;

protected:

  // protected methods
  //  
  
};


#endif // FUNCTIONSCIMSG_H