+Content:
+-------
+
This Folder contains :
- script : the sources of the generator,
- - doc : the associated documentation.
+ - src : the sources of the GUI
+ - CppExamples : Some C++ component examples.
+ - Doc : the associated documentation.
The generator is a script file called hxx2salome, written in bash, that manage :
- the compilation of generated module
- the update of Salome environment file
+A GUI called ghx2salome, written with Qt, is wrapping the script.
-Install:
-
- After installing files, you may :
- - set the environment variable HXXTOSALOME_ROOT_DIR to the directory that contains the hxx2salome script.
- This is not an obligation - but allow you to launch the script anywhere (if not set, you have to launch it locally).
- - configure the hxx2salome script (also not mandatory, but facilitates usage). For configuring the script, you can
- set the 4 variables defined at the beginning :
+Install:
+-------
+ The script can be used without any compilation.
+ To use the GUI, you first have to install and compile it.
- SALOME_SRC_DIR : directory where SALOME2 modules sources are stored. if present, generated module is created inside.
+ ./build_configure
+ ./configure --prefix=<absolute path of HXX2SALOME>
+ make
+ make install
- SALOME_BUILD_DIR : directory where you want to put build & install directories. may be the same than SALOME_SRC_DIR
- ENVIRON_FILE : salome2 environment file (.bash or .sh). If present, hxx2salome will propose to compile new module
- (by sourcing ENVIRON_FILE file, and executing build_configure, configure, make & make install).
- It will also propose to update this file with the new environment variabe necessary to run new module.
+
+Usage:
+-----
- CONFIGURE_OPTION : options passed to configure (for example --disable-debug or --enable-production )
+ set HXX2SALOME_ROOT_DIR variable to <absolute path of HXX2SALOME/bin>
+ with GUI :
+ --------
-Usage:
+ ${HXX2SALOME_ROOT_DIR}/gxx2salome
- ${HXX2SALOME_ROOT_DIR}/hxx2salome cppComponent_root_dir cppComponent.hxx libcppComponent.so
+ with script :
+ -----------
+
+ ${HXX2SALOME_ROOT_DIR}/hxx2salome [OPTIONS] cppComponent_root_dir cppComponent.hxx libcppComponent.so salome_install_dir
- cppComponent_root_dir : install directory (absolute path) of the c++ component
- cppComponent.hxx : header of the component
- libcppComponent.so :shared library of the component
(cppComponent.hxx and libcppComponent.so have to be found in cppComponent_root_dir!)
+ - salome_install_dir : the directory where you want to install the generated component
+
+ OPTIONS:
+ -c : to compile after code generation
+ -l : to launch salome after compilation
+ -e environment_file : to specify an salome environment file to source (for compiling)
+
-Examples:
+ Examples:
- ${HXX2SALOME_ROOT_DIR}/hxx2salome /home/crouzet/SALOME2/Generateur/TestMedCPP TestMed.hxx libTestMed.so
- ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL string1D_Salome.hxx libSTRUCT1DCXX.so
- ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL nsale_Salome.hxx libNSALECXX.so
- ${HXX2SALOME_ROOT_DIR}/hxx2salome /export/home/EcoleEte2004/CODES_INSTALL fsi_Salome.hxx libFSICXX.so
+ The following examples are based upon the C++ component given in CppExamples directory.
+ To proceed it is first necessary to compile them.
+ - export HXX2SALOME_ROOT_DIR=/home/crouzet/HXX2SALOME/bin;
+
+ - $HXX2SALOME_ROOT_DIR/hxx2salome -c -l -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL
+ Calculator.hxx libCALCULATORCXX.so /home/crouzet/SALOME2
+
+ - $HXX2SALOME_ROOT_DIR/hxx2salome -c -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL
+ Calc.hxx libCALCULCXX.so /home/crouzet/SALOME2
-Remark : to compile the c++ examples present in CppExamples, it is necessary to first source the env_products.csh file
- furnished with Salome.
