/*
* JNI interface to C code for MSG.
*
- * Copyright 2006,2007,2010 The SimGrid Team.
+ * Copyright 2006,2007,2010,2011 The SimGrid Team.
* All right reserved.
*
* This program is free software; you can redistribute
}
}
- /* FIXME: kill these C crufts */
- /** Returns the last error code of the simulation */
- public final static native int getErrCode();
-
/** Everything is right. Keep on going the way ! */
public static final int SUCCESS = 0;
/** You've done something wrong. You'd better look at it... */
public static final int FATAL_ERROR = 5;
- /** Retrieve the simulation time */
+ /** Retrieve the simulation time
+ * @return
+ */
public final static native double getClock();
- /** Issue an information logging message */
+ /** Issue an information logging message
+ * @param s
+ */
public final static native void info(String s);
/*********************************************************************************
public final static native void init(String[]args);
/**
- * Run the MSG simulation, and cleanup everything afterward.
+ * Run the MSG simulation.
*
- * If you want to chain simulations in the same process, you
- * should call again createEnvironment and deployApplication afterward.
+ * The simulation is not cleaned afterward (see
+ * {@link #clean()} if you really insist on cleaning the C side), so you can freely
+ * retrieve the informations that you want from the simulation. In particular, retrieving the status
+ * of a process or the current date is perfectly ok.
*
- * @see MSG_run, MSG_clean
+ * @see MSG_run
*/
public final static native void run() ;
+
+ /**
+ * Cleanup the MSG simulation.
+ *
+ * This function is only useful if you want to chain the simulations within
+ * the same environment. But actually, it's not sure at all that cleaning the
+ * JVM is faster than restarting a new one, so it's probable that using this
+ * function is not a brilliant idea. Do so at own risk.
+ *
+ * @see MSG_clean
+ */
+ public final static native void clean();
+
/**
* The native implemented method to create the environment of the simulation.
/**
* The method to deploy the simulation.
*
- * @param platformFile The XML file which contains the description of the application to deploy.
- */
+ *
+ * @param deploymentFile
+ */
public final static native void deployApplication(String deploymentFile);
- /** Example launcher. You can use it or provide your own launcher, as you wish */
+ /** Example launcher. You can use it or provide your own launcher, as you wish
+ * @param args
+ * @throws MsgException
+ */
static public void main(String[]args) throws MsgException {
/* initialize the MSG simulation. Must be done before anything else (even logging). */
Msg.init(args);
