Salome HOME
Go on for RequestSwitcher conquest
[modules/yacs.git] / idl / SALOME_ContainerManager.idl
index 27e34a110298ad812f738dc649e531256b413731..6b350082b6cf1653c203095b80bc8ffe46f0ec54 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -6,7 +6,7 @@
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -40,9 +40,15 @@ struct ContainerParameters
   string container_name;
 
   //! creation mode for GiveContainer if given else automatic 
-  /*!start creates a new container
-   * get  try to find an existing container
-   * getorstart   use an existing container if it exists or creates a new one
+  /*! List of possible values:
+   * "find" : search the first container whose name is container_name on
+   *          resources listed in resource_params.resList.
+   *          Return nil if none found.
+   * "findorstart" : same as "find", but start a new container if none found.
+   * "start" : create a new container. If there is already a container with the
+   *           same name on the chosen resource, it will be shut down.
+   * "get" : search an existing container on the best fitting resource.
+   * "getorstart" : same as "get", but start a new container if none found.
    */
   string mode;
 
@@ -54,7 +60,7 @@ struct ContainerParameters
   long nb_proc;
   //! if true start a MPI container
   boolean isMPI;
-  //! PaCO specific informations
+  //! PaCO specific information
   string parallelLib;
 
   //! Parameters to choose a resource