summaryrefslogtreecommitdiff
path: root/maximus/system/inc/ISystem.h
blob: 4d1ef885c2fd3d9bdcac7fa8305be89e5e0dbdef (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
/************************************************************************
                        ISystem.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/common/interfaces/ISystem.h
**************************************************************************/

#ifndef ISYSTEM_H
#define ISYSTEM_H

#include "sci_types.h"
#include "system_types.h"

#include <list>

class Station;
class INetworkClock;
class SystemSciMsg;

typedef std::list<Station*> StationsList;


/**
  * class ISystem
  */

class ISystem
{

public:

  // Constructors/Destructors
  //  

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

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

  // public methods
  //  

  /**
   * Indicate the default station executable to run when creating a station
   * @return bool
   * @param  default_station_executable the new value of mDefaultStationExecutable
   * @param  debugger the new value of mDebugger
   */
  virtual bool init ( const std::string & default_station_executable, const std::string & debugger ) = 0;

  /**
   * @return Sci_Msg_Station_Id
   */
  virtual Sci_Msg_Station_Id createStation ( const std::string & station_executable ) = 0;

  /**
   * @return bool
   * @param  system_sci_msg
   */
  virtual bool receiveIdleMsg ( const SystemSciMsg & system_sci_msg ) const = 0;

  /**
   * @return bool
   * @param  station_id
   */
  virtual bool removeStation ( Sci_Msg_Station_Id station_id ) = 0;

  /**
   * @return bool
   * @param  station_id
   */
  virtual bool deactivateStation ( Sci_Msg_Station_Id station_id ) = 0;

  /**
   * @return bool
   * @param  station_id
   */
  virtual bool activateStation ( Sci_Msg_Station_Id station_id ) = 0;

  /**
   * @return bool
   * @param  station_id
   */
  virtual bool debugStation ( const Sci_Msg_Station_Id station_id ) = 0;

  /**
   * @return bool
   */
  virtual bool isStationIdle ( Sci_Msg_Station_Id station_id ) const = 0;

  /**
   * @return bool
   * @param  station_id
   * @param  new_status
   */
  virtual bool updateStationStatus ( const Sci_Msg_Station_Id station_id, const Station_Status new_status ) = 0;

  /**
   * Get the value of mListOfStations
   * @return the value of mListOfStations
   */
  virtual StationsList * getListOfStations ( ) = 0;

  /**
   * @return bool
   */
  virtual bool areAllActiveStationsIdle ( ) const = 0;

  /**
   * @return bool
   * @param  p_network_clock the new value of mpNetworkClock
   */
  virtual bool setNetworkClock ( INetworkClock * p_network_clock ) = 0;

  /**
   * @return mDefaultStationExecutable
   */
  virtual const std::string & getDefaultStationExecutable ( ) const = 0;

  /**
   * @return bool
   * @param  station_id the station ID
   * @param  station_name the new value of the station name
   */
  virtual bool setStationName ( const Sci_Msg_Station_Id station_id, const std::string & station_name ) = 0;

};


#endif // ISYSTEM_H