- create a SALOME component that can be loaded by a C++ container
- configure the module so that the component is known to SALOME
- add a graphic GUI
- - make the component useable in the YACS module.
+ - make the component usable in the YACS module.
Creating the module tree structure
=======================================
We need to reproduce the following standard file tree structure, to use it in a SALOME module::
+ HELLO1_SRC
- + build_configure
- + configure.in.base
- + Makefile.in
+ + CMakeLists.txt
+ adm_local
- + unix
- + make_commence.in
- + make_omniorb.in
- + config_files
+ + CMakeLists.txt
+ + cmake_files
+ + CMakeLists.txt
+ + FindSalomeHELLO.cmake
+ bin
+ + CMakeLists.txt
+ VERSION
+ runAppli.in
+ runSalome.py
+ idl
- + Makefile.in
+ + CMakeLists.txt
+ HELLO_Gen.idl
+ src
- + Makefile.in
+ + CMakeLists.txt
+ HELLO
- + Makefile.in
+ + CMakeLists.txt
+ HELLO.cxx
+ HELLO.hxx
+ doc
const char *instanceName,
const char *interfaceName);
virtual ~HELLO();
- HELLO_ORB::status hello ( SALOMEDS::Study_ptr study, const char* name );
- HELLO_ORB::status goodbye( SALOMEDS::Study_ptr study, const char* name );
+ HELLO_ORB::status hello ( const char* name );
+ HELLO_ORB::status goodbye( const char* name );
void copyOrMove( const HELLO_ORB::object_list& what,
SALOMEDS::SObject_ptr where,
CORBA::Long row, CORBA::Boolean isCopy );
The definitions of the constructor and the HELLOEngine_factory instantiation function (both normalized!),
hello, goodbye and copyOrMove are given in the source file (HELLO.cxx)::
- HELLO_ORB::status HELLO::hello( SALOMEDS::Study_ptr study, const char* name )
+ HELLO_ORB::status HELLO::hello( const char* name )
{
...
}
- HELLO_ORB::status HELLO::goodbye( SALOMEDS::Study_ptr study, const char* name )
+ HELLO_ORB::status HELLO::goodbye( const char* name )
{
...
}
...
}
-Makefile
---------
-In makefile, some targets have to be defined::
-
- # header files
- salomeinclude_HEADERS = HELLO.hxx
-
- # Libraries targets
- lib_LTLIBRARIES = libHELLOEngine.la
- dist_libHELLOEngine_la_SOURCES = \
- HELLO.cxx
-
- libHELLOEngine_la_CPPFLAGS = \
- $(CORBA_CXXFLAGS) \
- $(CORBA_INCLUDES) \
- $(KERNEL_CXXFLAGS) \
- -I$(top_builddir)/idl
-
- libHELLOEngine_la_LDFLAGS = \
- ../../idl/libSalomeIDLHELLO.la \
- $(KERNEL_LDFLAGS) \
- -lSalomeContainer \
- -lOpUtil \
- -lSalomeIDLKernel
+CMakeLists.txt
+--------------
+Create and add library to the project::
+
+ # --- options ---
+ # additional include directories
+ INCLUDE_DIRECTORIES(
+ ${KERNEL_INCLUDE_DIRS}
+ ${OMNIORB_INCLUDE_DIR}
+ ${PROJECT_BINARY_DIR}
+ ${PROJECT_BINARY_DIR}/idl
+ )
+ # libraries to link to
+ SET(_link_LIBRARIES
+ ${OMNIORB_LIBRARIES}
+ ${KERNEL_SalomeIDLKernel}
+ ${KERNEL_OpUtil}
+ ${KERNEL_SalomeContainer}
+ SalomeIDLHELLO
+ )
+ # --- headers ---
+ # header files / no moc processing
+ SET(HELLO_HEADERS
+ HELLO.hxx
+ )
+ # --- sources ---
+ # sources / static
+ SET(HELLO_SOURCES
+ HELLO.cxx
+ )
+ # --- rules ---
+ ADD_LIBRARY(HELLOEngine ${HELLO_SOURCES})
+ TARGET_LINK_LIBRARIES(HELLOEngine ${_link_LIBRARIES} )
+ INSTALL(TARGETS HELLOEngine EXPORT ${PROJECT_NAME}TargetGroup DESTINATION ${SALOME_INSTALL_LIBS})
+ INSTALL(FILES ${HELLO_HEADERS} DESTINATION ${SALOME_INSTALL_HEADERS})
-Review each of these targets
+Review some of components:
-- salomeinclude_HEADERS contains the header files.
-- lib_LTLIBRARIES contains the normalized name (lib<Nom_Module>Engine.la) of the library, LIB_SRC defines the name of source files, and VPATH defines the directories in which they can be found.
-- The path for the include files used has to be added to CPPFLAGS (SALOME.config.h, SALOME_Component_i.hxx and utilities.h are located in ${KERNEL_ROOT_DIR}/include/salome).
-- The HELLO class uses lib libraries (for Engines_Component_i) and libOptUtil (for PortableServer and Salome_Exception). Therefore, the name of these libraries and their path in LDFLAGS will be indicated. Other libraries are often useful, for example libsalomeDS if persistence is implemented, or libSalomeNS if the naming service is used.
+- HELLO_HEADERS contains the header files.
+- HELLO_SOURCES defines the name of source files
+- HELLOEngine - library name.
+- SALOME_INSTALL_LIBS path defines the directories in which library will be install.
+- Command INCLUDE_DIRECTORIES used to add /bin directories of some modules and packages.
+- Variable _link_LIBRARIES contains path to libraries of dependent modules and packages.
Controlling the component from Python (TUI mode)
=====================================================
>>> print hello
<HELLO_ORB._objref_HELLO_Gen instance at 0x8274e94>
- >>> status=hello.hello(salome.myStudy, "Nicolas")
+ >>> status=hello.hello("Nicolas")
>>> print status
OP_OK
dialog boxes and other such staff.
- src/HELLOGUI/HELLO_msg_en.ts
+- src/HELLOGUI/HELLO_msg_fr.ts
- src/HELLOGUI/HELLO_icons.ts
These files provide a description (internationalization) of GUI
