README

   1
   2 This Folder contains :
   3   - script      : the sources of the generator,
   4   - doc         : the associated documentation.
   5
   6
   7 The generator is a script file called hxx2salome, written in bash, that manage :
   8   - the code generation
   9   - the compilation of generated module
  10   - the update of Salome environment file
  11
  12
  13 Install:
  14
  15   After installing files, you may :
  16
  17    - set the environment variable HXXTOSALOME_ROOT_DIR to the directory that contains the hxx2salome script.
  18      This is not an obligation - but allow you to launch the script anywhere (if not set, you have to launch it locally).
  19
  20    - configure the hxx2salome script (also not mandatory, but facilitates usage). For configuring the script, you can
  21      set the 4 variables defined at the beginning :
  22
  23
  24        SALOME_SRC_DIR : directory where SALOME2 modules sources are stored. if present, generated module is created inside.
  25
  26        SALOME_BUILD_DIR : directory where you want to put build & install directories. may be the same than SALOME_SRC_DIR
  27
  28        ENVIRON_FILE : salome2 environment file (.bash or .sh). If present, hxx2salome will propose to compile new module
  29                       (by sourcing ENVIRON_FILE file, and executing build_configure, configure, make & make install).
  30                       It will also propose to update this file with the new environment variabe necessary to run new module.
  31
  32        CONFIGURE_OPTION : options passed to configure (for example --disable-debug or --enable-production )
  33
  34
  35 Usage:
  36
  37     ${HXX2SALOME_ROOT_DIR}/hxx2salome   cppComponent_root_dir   cppComponent.hxx   libcppComponent.so
  38
  39          - cppComponent_root_dir : install directory (absolute path) of the c++ component
  40          - cppComponent.hxx : header of the component
  41          - libcppComponent.so :shared library of the component
  42            (cppComponent.hxx and libcppComponent.so have to be found in cppComponent_root_dir!)
  43
  44
  45 Examples:
  46
  47     ${HXX2SALOME_ROOT_DIR}/hxx2salome /home/crouzet/SALOME2/Generateur/TestMedCPP TestMed.hxx libTestMed.so
  48     ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL string1D_Salome.hxx  libSTRUCT1DCXX.so
  49     ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL nsale_Salome.hxx  libNSALECXX.so
  50     ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL fsi_Salome.hxx  libFSICXX.so
  51
  52
  53
  54
  55 Remark :  to compile the c++ examples present in CppExamples, it is necessary to first source the env_products.csh file
  56           furnished with Salome.