« Process management » : différence entre les versions

De GENIUS
Aller à la navigation Aller à la recherche
Aucun résumé des modifications
Aucun résumé des modifications
 
(4 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
=== The Command Launcher ===
== The Command Launcher ==


It is good to have a <font color=#FF8C00>GUI</font>... but it has to be useful ! And most of the time, it is used to launch a computation program. Several solutions are available:
It is good to have a <font color=#FF8C00 title="Grahical User Interface>GUI</font> ... but it has to be useful ! And most of the time, it is used to launch a computation program. Several solutions are available:
* Launch a Java thread … but it could not be stopped <font color=#FF0000>asynchronously</font> (<font color=#4169E1>stop()</font> method is deprecated) except by stopping the <font color=#FF8C00>GUI</font>!!!
* Launch a Java thread … but it could not be stopped <font color=#FF0000>asynchronously</font> (<font color=#4169E1>stop()</font> method is deprecated) except by stopping the <font color=#FF8C00 title="Grahical User Interface>GUI</font> !!!
* Launch an executable independent of the <font color=#FF8C00>GUI</font>
* Launch an executable independent of the <font color=#FF8C00 title="Grahical User Interface>GUI</font>


<font color=#556B2F>'''GENIUS'''</font> makes available classes [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GJavaCommandLauncher.html GJavaCommandLauncher], [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.html GCommandLauncher], [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecButton.html GExecButton] and [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecMenuItem.html GExecMenuItem]. They will launch:
<font color=#556B2F>'''GENIUS'''</font> makes available classes [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GJavaCommandLauncher.html GJavaCommandLauncher], [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.html GCommandLauncher], [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecButton.html GExecButton] and [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecMenuItem.html GExecMenuItem]. They will launch:
Ligne 29 : Ligne 29 :
</syntaxhighlight>
</syntaxhighlight>


=== Pre-process (before) ===
== Pre-process (before) ==


Considering we implement the GListener interface, we may execute some action inside the <font color=#4169E1>before()</font> method (for example, testing that all input data are OK):
Considering we implement the GListener interface, we may execute some action inside the <font color=#4169E1>before()</font> method (for example, testing that all input data are OK):
Ligne 52 : Ligne 52 :
</syntaxhighlight>
</syntaxhighlight>


=== Post-process (after) ===
== Post-process (after) ==


Once, the executable has stoppped, we may also execute some other actions. But be careful of the fact that:
Once, the executable has stoppped, we may also execute some other actions. But be careful of the fact that:
* we will pass through the //after()// method after clicking on the [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecButton.html GExecButton] (or the [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecMenuItem.html GExecMenuItem]) ... that does not mean that the process is finished. So, we will use the <font color=#4169E1>getFinalnalSource()</font> method (as explained in [[Glistener#How to know which widget has been selected|GListener section]]).
* we will pass through the //after()// method after clicking on the [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecButton.html GExecButton] (or the [{{PathCurrentJavaDoc}}/fr/cnes/genius/threads/GCommandLauncher.GExecMenuItem.html GExecMenuItem]) ... that does not mean that the process is finished. So, we will use the <font color=#4169E1>getFinalnalSource()</font> method (as explained in [[GListener_interface#How to know which widget has been selected ?|GListener interface section]]).
* the process may have stoppped nominally or because we stopped it before its end.
* the process may have stoppped nominally or because we stopped it before its end.


Ligne 78 : Ligne 78 :
</syntaxhighlight>
</syntaxhighlight>


=== GProgressBar ===
== GProgressBar ==


Another interesting widget is [{{PathCurrentJavaDoc}}/fr/cnes/genius/lowLevel/GProgressBar.html GProgressBar] to know the evolution of the computation process.
Another interesting widget is [{{PathCurrentJavaDoc}}/fr/cnes/genius/lowLevel/GProgressBar.html GProgressBar] to know the evolution of the computation process.

Dernière version du 10 juillet 2017 à 07:56

The Command Launcher

It is good to have a GUI ... but it has to be useful ! And most of the time, it is used to launch a computation program. Several solutions are available:

  • Launch a Java thread … but it could not be stopped asynchronously (stop() method is deprecated) except by stopping the GUI !!!
  • Launch an executable independent of the GUI

GENIUS makes available classes GJavaCommandLauncher, GCommandLauncher, GExecButton and GExecMenuItem. They will launch:

  • Either a Java class, if it owns a « main » static method
  • Either an executable (for example issued from a Fortran compilation)

A consequence is that entry data will only be passed by files.

First, we will have to instantiate a GJavaCommandLauncher or a GCommandLauncher. Here is an example launching a Java executable class:

GJavaCommandLauncher cmd;
String path = System.getProperty("java.class.path");
cmd = new GJavaCommandLauncher ( new String[] {"myClass", "args …"}, path,
                                 "Start computation", "Stop computation", null);
// To assign the process output towards the standard output
cmd.setCopyOutputToStdout(true);

Issued from this cmd object, we could get the associated launch button and item menu:

GExecButton butExec = cmd.getGExecButton();
GExecMenuItem itemExec = cmd.getGExecMenuItem();

Pre-process (before)

Considering we implement the GListener interface, we may execute some action inside the before() method (for example, testing that all input data are OK):

public void before(GEvent e) throws GFileManipulatorException {

  if ( e.contains(butExec,itemExec) ) { // Launch button or menu have been activated
  
    if ( ! cmd.isRunning() ) { // Program is not yet running, so we may initialize it 
      if ( valeursOK ) { // Flag indicating values are OK (for example)
        GFileManipulation.writeConfig("data.xml", "MAN", objetIhm); // We prepare the input data file
      }
      else {
        cmd.setInhibited(true); // Finally, we do not launch the process !
      }
    }

  }
  
}

Post-process (after)

Once, the executable has stoppped, we may also execute some other actions. But be careful of the fact that:

  • we will pass through the //after()// method after clicking on the GExecButton (or the GExecMenuItem) ... that does not mean that the process is finished. So, we will use the getFinalnalSource() method (as explained in GListener interface section).
  • the process may have stoppped nominally or because we stopped it before its end.

The example below shows how to manage this situation:

public void after(GEvent e) {

  if ( e.getFinalSource() == cmd ) {
  
    // We actually launched the application
    if ( cmd.getProcessStatus() == ProcessStatus.FINISHED_NORMALY ) {
      System.out.println("Computation nominally finished ...");
    }
    else if ( cmd.getProcessStatus() == ProcessStatus.FINISHED_BY_USER ) {
      System.out.println("Computation stopped by user ...");
    }
    
  }
  
}

GProgressBar

Another interesting widget is GProgressBar to know the evolution of the computation process.

  // Getting the progress bar from the cmd object
  GProgressBar pBar = cmd.getGProgressBar();
  
  // Calling corresponding swing object to resize it
  pBar.getJProgressBar().setPreferredSize(new Dimension(250,30));

  
  
  public void generic() throws GException {
    put(cmd);
    ...
    put(pBar); // Display as any other widget 
 }

  
  
  public void display() throws GException { generic(); }
  
  


The computation program will send the information as this:

  • Send on the standard output "@value@\n" with value between 0 and 100
  • Or use GEnvironment.sendProgress(value) with value between 0 and 100

It is possible to force the value with the setValue(val) method.


GProgressBar.jpg


Return to the introduction ↑ Go to the next page →