lcio.h

Go to the documentation of this file.

// -*- C++ -*-
#ifndef LCIO_NAMESPACE_H
#define LCIO_NAMESPACE_H 1


/*Declaration of the namespace lcio. Also serves as a source for package/namespace 
 * documentation with doxygen. 
 * 
 * @author gaede
 * @version $Id: lcio.h,v 1.27 2006/12/08 15:38:15 gaede Exp $ 
 * @see LCEvent
 */
#include "EVENT/LCIO.h"
#include "IOIMPL/LCFactory.h"
#include "IMPL/LCIOExceptionHandler.h"


/** The namespace DATA has been removed from LCIO all data entities are now defined in EVENT.
 */
namespace DATA{}
/** The namespace EVENT holds all base interfaces of the event entities.
 */
namespace EVENT{}

/** The namespace IO  holds the base interfaces for io of data. 
 */
namespace IO{}

/** The namespace IMPL holds the implementations of
 * the base interfaces that are defined in EVENT.
 */
namespace IMPL{}

/** The namespace UTIL holds convenient and support classes and 
 *  methods for the LCIO objects.
 */
namespace UTIL{}


/** The namespace lcrtrel holds classes and functions for runtime extensions and relations
 *  see LCRTRelations for more detailed documentation.
 * 
 */
namespace lcrtrel{}


/** The LCIO namespace combines EVENT, IO, IMPL and UTIL for user convenience. 
 */
namespace lcio{

  using namespace EVENT ;

  using namespace IO ;

  using namespace IMPL ;

  using namespace UTIL ;

  using namespace lcrtrel ;

  using IOIMPL::LCFactory ;

}

/** The IOIMPL namespace holds extensions to the default implementations
 * needed for IO. For internal use only - with the exception of IOIMPL::LCFactory.
 */
namespace IOIMPL{}


/** The SIO namespace holds the persistency implementation using SIO.
 * Users should not use any of the classes defined here explicitly but through their
 * base interfaces defined in IO.
 */
namespace SIO{}


/** Use this macro to catch uncaught exceptions before aborting the program.
 *  Only needed if LCIO is used without LCWRiter or LCReader.
 */
#define HANDLE_LCIO_EXCEPTIONS lcio::LCIOExceptionHandler::createInstance() ;


#endif // LCIO_NAMESPACE_H

---