summaryrefslogtreecommitdiff
path: root/cesar/maximus/functioncall/inc/FunctionCallManager.h
blob: b7027285b6db003dd8dc8ada6e8ee1369e0211db (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
/************************************************************************
                        FunctionCallManager.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/FunctionCallManager.h
**************************************************************************/

#ifndef FUNCTIONCALLMANAGER_H
#define FUNCTIONCALLMANAGER_H

#include "IFunctionCall.h"

#include "networkclock_types.h"

class FunctionSciMsg;
class ISci;


/**
  * class FunctionCallManager
  */

class FunctionCallManager : public IFunctionCall
{

public:

  // public attributes
  //
  
private:

  // private attributes
  //  
  CallbacksList mListOfCallbacks;
  ISci * mpSciServer;
  
protected:

  // protected attributes
  // 
  
public:

  // Constructors/Destructors
  //  

  /**
   * Constructor
   */
  FunctionCallManager ( ISci * p_sci_server );

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

  // public methods
  //  

  /**
   * @return FunctionSciMsg *
   */
  FunctionSciMsg * createMsg ( );

  /**
   * @return bool
   * @param  msg_id
   * @param  callback_address
   */
  bool registerCallback ( Function_Call_Msg_Id msg_id, const CallbackFunction & callback_address );

  /**
   * @return bool
   * @param  p_function_sci_msg
   */
  bool sendMsg ( FunctionSciMsg * p_function_sci_msg_to_send );
  
  /**
   * @return bool
   * @param  function_sci_msg
   */
  bool sendMsg ( FunctionSciMsg & function_sci_msg_to_send );
    
  /**
   * @return bool
   * @param  function_sci_msg
   */
  bool receiveMsg ( const FunctionSciMsg & function_sci_msg );
  
  // public attribute accessor methods
  //  

  // private attribute accessor methods
  //  
  
  /**
   * @return pointer to mListOfCallbacks
   */
  CallbacksList * getListOfCallbacks ( );
  
  // protected attribute accessor methods
  //  

private:

  // private methods
  //  

  void initAttributes ( );
  
  bool registerFunctionSciMsg ( );
  
  void displayListOfCallbacks ( ) const;
    
protected:

  // protected methods
  //  

};


#endif // FUNCTIONCALLMANAGER_H