GETProcessLink.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETProcessLink.hh
 *
 *  Include file for the GETProcessLink class.
 */
//======================================================================

#ifndef GET_PROCESS_LINK_HH
#define GET_PROCESS_LINK_HH

//----------------------------------------------------------------------

#include "GETCommon.hh"
#include "GETProcess.hh"

//======================================================================
/*! \class GETProcessLink
 *
 *  This class is used to connect processes to GET core objects.
 *  It defines whether the process is defined individually (local data) or
 *  globally (external data).
 *
 *  If the data is defined externally, it is just a pointer to that data,
 *  and the corresponding object is fully managed by calling code (the data
 *  object should exist as long as it is used by the object it is associated
 *  to requires it...).
 *
 *  If the data is defined locally, then the pointer is adopted, and the
 *  data object is deleted when modified or when the class is deleted.
 *
 */
class GETProcessLink
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETProcessLink);
  //------------------------------------------------------------

  protected:
    GETProcess  * process_ptr;  ///< Pointer to associated data
    bool          is_local;     ///< Indicate whether the data is defined locally or externally

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETProcessLink ( GETProcess * proc = NULL, bool local = true );
    virtual ~GETProcessLink ( );
  //@}


  //----------------------------------------------------------
  /** @name Associated data functions */
  //@{
    virtual void SetProcess           ( GETProcess * proc, bool local = true );  // inline
    virtual void SetLocalProcess      ( GETProcess * proc );                     // inline
    virtual void SetExternalProcess   ( GETProcess * proc );                     // inline

    const GETProcess  * GetProcess ( ) const;   // inline
          GETProcess  * GetProcess ( );         // inline

    bool                IsLocal   ( ) const;    // inline
    bool                IsDefined ( ) const;    // inline

    virtual void        InitProcess ( u_int n, double dt );  // inline
    virtual void        RemoveProcess ( );
  //@}


  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:

    /*! for use within ROOT.*/
    ClassDef(GETProcessLink,0);
  //@}
};


//----------------------------------------------------------------------
//  Inline functions
#include "icc/GETProcessLink.icc"


//======================================================================
#endif