Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a679ed7098256a148db61ddba96db080aa59e935
[simgrid.git] / docs / source / java / org / simgrid / msg / Msg.rst
1 class org.simgrid.msg.Msg
2 =========================
3
4 .. java:package:: org.simgrid.msg
5    :noindex:
6
7 .. java:type:: public final class Msg
8
9 Methods
10 -------
11 createEnvironment
12 ^^^^^^^^^^^^^^^^^
13
14 .. java:method:: public static final native void createEnvironment(String platformFile)
15    :outertype: Msg
16
17    Create the simulation environment by parsing a platform file.
18
19 critical
20 ^^^^^^^^
21
22 .. java:method:: public static final native void critical(String s)
23    :outertype: Msg
24
25    Issue a critical logging message.
26
27 debug
28 ^^^^^
29
30 .. java:method:: public static final native void debug(String msg)
31    :outertype: Msg
32
33    Issue a debug logging message.
34
35 deployApplication
36 ^^^^^^^^^^^^^^^^^
37
38 .. java:method:: public static final native void deployApplication(String deploymentFile)
39    :outertype: Msg
40
41    Starts your processes by parsing a deployment file.
42
43 energyInit
44 ^^^^^^^^^^
45
46 .. java:method:: public static final native void energyInit()
47    :outertype: Msg
48
49    Tell the kernel that you want to use the energy plugin
50
51 environmentGetRoutingRoot
52 ^^^^^^^^^^^^^^^^^^^^^^^^^
53
54 .. java:method:: public static final native As environmentGetRoutingRoot()
55    :outertype: Msg
56
57 error
58 ^^^^^
59
60 .. java:method:: public static final native void error(String msg)
61    :outertype: Msg
62
63    Issue an error logging message.
64
65 fileSystemInit
66 ^^^^^^^^^^^^^^
67
68 .. java:method:: public static final native void fileSystemInit()
69    :outertype: Msg
70
71    Tell the kernel that you want to use the filesystem plugin.
72
73 getClock
74 ^^^^^^^^
75
76 .. java:method:: public static final native double getClock()
77    :outertype: Msg
78
79    Retrieves the simulation time
80
81 info
82 ^^^^
83
84 .. java:method:: public static final native void info(String msg)
85    :outertype: Msg
86
87    Issue an information logging message
88
89 init
90 ^^^^
91
92 .. java:method:: public static final native void init(String[] args)
93    :outertype: Msg
94
95    Initialize a MSG simulation.
96
97    :param args: The arguments of the command line of the simulation.
98
99 loadInit
100 ^^^^^^^^
101
102 .. java:method:: public static final native void loadInit()
103    :outertype: Msg
104
105    Initializes the HostLoad plugin. The HostLoad plugin provides an API to get the current load of each host.
106
107 main
108 ^^^^
109
110 .. java:method:: public static void main(String[] args)
111    :outertype: Msg
112
113    Example launcher. You can use it or provide your own launcher, as you wish
114
115    :param args:
116
117 run
118 ^^^
119
120 .. java:method:: public static final native void run()
121    :outertype: Msg
122
123    Run the MSG simulation. After the simulation, you can freely retrieve the information that you want.. In particular, retrieving the status of a process or the current date is perfectly ok.
124
125 verb
126 ^^^^
127
128 .. java:method:: public static final native void verb(String msg)
129    :outertype: Msg
130
131    Issue a verbose logging message.
132
133 warn
134 ^^^^
135
136 .. java:method:: public static final native void warn(String msg)
137    :outertype: Msg
138
139    Issue a warning logging message.
140