summaryrefslogtreecommitdiff
path: root/cesar/maximus/sci/inc/ISci.h
blob: cea7f4b954ba402916e97f92ff9a6b05e18d32c4 (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
/************************************************************************
                        ISci.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/sci/inc/ISci.h
**************************************************************************/

#ifndef ISCI_H
#define ISCI_H

#include "ISystem.h"

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

#include <string>
#include <vector>

class SciMsg;

typedef std::vector<Sci_Msg_Station_Id> DestStationsList;


/**
 * class ISci
 */

class ISci
{

public:

  // Constructors/Destructors
  //  

  /**
   * Empty Constructor
   */
  ISci ( ) { }

  /**
   * Empty Destructor
   */
  virtual ~ISci ( ) { }

  // public methods
  //  

  /**
   * @return bool
   * @param  station_log_file 
   */
  virtual bool init ( const std::string station_log ) = 0;

  /**
   * @return bool 
   */
  virtual bool process ( ) = 0;

  /**
   * @return bool
   * @param  sci_msg_to_send
   */
  virtual bool fillSciMsg ( SciMsg & sci_msg_to_send ) const = 0;

  /**
   * @return bool
   * @param  sci_msg_to_send
   */
  virtual bool sendSciMsg ( const SciMsg & sci_msg_to_send ) const = 0;

  /**
   * @return bool
   * @param  sci_msg_to_send
   */
  virtual bool sendSciMsgToAllActiveStations ( SciMsg & sci_msg_to_send ) const = 0;

  /**
   * @return bool
   * @param  sci_msg_to_send
   * @param  list_of_dest_stations
   */
  virtual bool sendSciMsgToDestStations ( SciMsg & sci_msg_to_send, DestStationsList & list_of_dest_stations ) const = 0;

 /**
   * Set a value into mpSpecializedSciMsgArray
   * @return bool
   * @param  sci_msg_type the array position to set
   * @param  sci_msg the new value of mpSpecializedSciMsgArray[sci_msg_type]
   */
  virtual bool registerSpecializedSciMsg ( const Sci_Msg_Type sci_msg_type, SciMsg * sci_msg ) = 0;
  
  /**
   * @return bool
   * @param  header
   * @param  data_length
   * @param  received_data
   */
  virtual bool receiveMsg ( const Sci_Msg_Header * header,
                            const unsigned long data_length,
                            const unsigned char * received_data ) const = 0;

  virtual void displaySpecializedSciMsgArray ( ) const = 0;

  /**
   * @return bool
   * @param  p_list_of_stations
   */
  virtual bool setStationsList ( StationsList * p_list_of_stations ) = 0;

  /**
   * @return bool
   * @param  current_tick_value
   */
  virtual bool updateTickValue ( const Network_Clock_Tick current_tick_value ) = 0;

};


#endif // ISCI_H