GETDocUsingLibrary.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETDocUsingLibrary.hh
 *
 *  Documentation page for how to use the library.
 */
//======================================================================


//======================================================================
/*! \page get_page_linking Linking the library to C++ codes
 *
 *  Some scripts are generated automatically at compilation time.
 *  If the shell environment is set properly, these scripts are
 *  accessible from a shell terminal. 
 *
 *  - \b get_cpp gives the compiler options used to build the library
 *  - \b get_inc gives all the include directive options required
 *    for C++ compilation with the GET library
 *  - \b get_lib gives the options required to link a program with
 *    the GET library and all other needed libraries
 *
 *  The scripts \b get_base_inc and  \b get_base_lib show only the
 *  options related to the GET library, and not the other libraries.
 *
 *  The following is an example of a simplified makefile:
 *  \code

  # Compilation options
  CPP           := g++
  CPPFLAGS      := ${shell get_cpp}
  INCFLAGS      := ${shell get_inc}
  LDFLAGS       := ${shell get_lib}

  # Library source file
  MY_SRC        := #$(shell ls *.cpp)
  MY_OBJ        := #$(LIB_SRC:%.cpp=%.o)
  MY_INC        := #$(shell ls *.hh)

  # Program executable
  EXE           := my_program

  #===============================================================
  # Dependencies

  all:          ${EXE}
                        @echo ""
                        @echo "Programs:"
                        @echo "    "${EXE}
                        @echo ""

  # Object files
  %.o:          %.cpp ${MY_INC}
                        @echo ""
                        @echo "--> Compiling object $*"
                        ${CPP} $< ${CPPFLAGS} ${INCFLAGS} -c -o $@
                        @echo ""

  # Program
  ${EXE}:       ${MY_OBJ}
                        @echo ""
                        @echo "--> Linking program $*"
                        ${CPP} $< ${CPPFLAGS} ${INCFLAGS} ${LDFLAGS} -o $*
                        @echo ""

 \endcode
 *
 *  
 */


//======================================================================
/*! \page get_page_embed_root Loading the library in a ROOT session
 *
 *  In order to use the libraries within a ROOT session, the ROOT
 *  configuration file (\b .rootrc) must be customized in order to declare
 *  the files locations.
 *
 *  Here is an example of the required declarations:
 *
 *  \code
# ROOT Configuration file (.rootrc)

Unix.*.Root.DynamicPath:    .:$(ROOTSYS)/lib:$(JG_ROOT_LIB)
Unix.*.Root.MacroPath:      .:$(ROOTSYS)/macros:$(JG_ROOT_MACRO):$(JG_ROOT_LIB)

# ACLiC customization.
ACLiC.IncludePaths:         -I$(GCPP_INC) -I$(JG_ROOT_INC)
 
# Rint (interactive ROOT executable) specific alias, logon and logoff macros.
Rint.Logon:                 my_rootlogon.C
 *  \endcode
 *
 *
 *  It is also possible to automatically load the libraries at root session
 *  start, by calling the scripts provided with the libraries.
 *
 *  Adding the following lines to your own ROOT logon script (see \b .rootrc
 *  file), the following libraries will be loaded, and the corresponding
 *  include directories will be declared in your ROOT session:
 *  - GCpp, GRootTools and GFFT libraries (J. Giovinazzo)
 *  - MFM and TinyXML libraries
 *  - Xerces-C XML parsing libraries
 *  - GET and GETRoot libraries (J. Giovinazzo)
 *
 *  \code
{
  //----------------------------------------------------------------------------
  // this is to avoid a problem with the corresponding ROOT library...
  TRotation *_t_rotation_dummy_ = NULL;

  //----------------------------------------------------------------------------
  // Additionnal JG libraries for ROOT
  //----------------------------------------------------------------------------
  if (getenv("JG_ROOT_MACRO") != NULL)
  {
    gROOT->Macro ( (TString(getenv("JG_ROOT_MACRO"))) + "/root_base_libs.C" );
  }
  else
    cerr << "env. variable JG_ROOT_MACRO not defined" << endl;

  //----------------------------------------------------------------------------
  // GFFT libraries
  //----------------------------------------------------------------------------
  if (getenv("GFFT_BASE") != NULL)
  {
    gROOT->Macro ( (getenv("GFFT_BASE")+string("/root/GFFTRootLibs.C")).c_str() );
  }

  //----------------------------------------------------------------------------
  // GET Analysis libraries
  // (it also loads the TinyXML and the MFM libraries)
  //----------------------------------------------------------------------------
  if (getenv("GET_BASE") != NULL)
  {
    gROOT->Macro ( (getenv("GET_BASE")+string("/root/GETRootLibs.C")).c_str() );
  }
}
 *  \endcode
 *
 */