Important Files of the Your Module

This web pages describes the selected files of your project. Please note that this web page does not describe all files of your project, neither it gives the philosopy and structure of the 3DVDM system. For the general philosophy and system architecture of the 3DVDM and VR++ systems please refer to VR++ 0.8.0 Programmer's Guide and VR++ 0.8.0 Reference Manual.

In this web page we assume that the project of interest is located in the new_module directory. The name of the project is NewModule.

There are three important groups of files: the include files, mapper files, and control of data communication files. We describe each group of files individually.

The mapper files are the most important files of your module. The mapper class of your module maps the data source (DB module of the system) with the visualization destination (VR++ module of the system). The files contain the NewModuleMapper::calculateProperties function. This function is invoked whenever the user updates any parameters of the module via GUI.

  new_module/tasks/NewModuleMapper.cc
  new_module/tasks/Makefile

The NewModuleMapper.cc consists the calculateProperties function. Place your code into this function or add additional C/C++ files for your code. In the later case, introduce additional rules in the Makefile file describing how to produce object files.

The include files contain header information of your classes. Please place all header files of variables, class definitions, and function prototypes into the new_module/include/3dvdm/new_module directory which you want to share for the other modules. For example, ds/include/3dvdm/ds/3dapdf.h is the header file of the APDF class. By adding #include <3dvdm/ds/3dapdf.h> in his code one can use all the functions and data definition defined by the APDF method.

  new_module/include/3dvdm/new_module
  new_module/include/3dvdm/new_module/NewModuleMapper.h

NewModuleMapper.h contains the class definition of your mapper.

Control of data communication files associate the variables of your mapper with the elements of the GUI. The files are listed in the following table:

  new_module/masters/NewModuleMaster.cxx
  new_module/tasks/NewModuleMapper.cc

NewModuleMaster.cxx defines the mapping between the variables and the menus. NewModuleMapper.cc defines the GUI menu and the mapping between the menu and the variables of your module.