ClusterSequenceWrapper.hh

00001 //STARTHEADER
00002 // $Id: ClusterSequenceWrapper.hh 1885 2011-01-27 14:50:21Z salam $
00003 //
00004 // Copyright (c) 2005-2010, Matteo Cacciari, Gavin Salam and Gregory Soyez
00005 //
00006 //----------------------------------------------------------------------
00007 // This file is part of FastJet.
00008 //
00009 //  FastJet is free software; you can redistribute it and/or modify
00010 //  it under the terms of the GNU General Public License as published by
00011 //  the Free Software Foundation; either version 2 of the License, or
00012 //  (at your option) any later version.
00013 //
00014 //  The algorithms that underlie FastJet have required considerable
00015 //  development and are described in hep-ph/0512210. If you use
00016 //  FastJet as part of work towards a scientific publication, please
00017 //  include a citation to the FastJet paper.
00018 //
00019 //  FastJet is distributed in the hope that it will be useful,
00020 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00021 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00022 //  GNU General Public License for more details.
00023 //
00024 //  You should have received a copy of the GNU General Public License
00025 //  along with FastJet; if not, write to the Free Software
00026 //  Foundation, Inc.:
00027 //      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00028 //----------------------------------------------------------------------
00029 //ENDHEADER
00030 
00031 
00032 #ifndef __FASTJET_CLUSTER_SEQUENCE_WRAPPER_HH__
00033 #define __FASTJET_CLUSTER_SEQUENCE_WRAPPER_HH__
00034 
00035 #include "fastjet/internal/base.hh"
00036 
00037 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00038 
00039 class ClusterSequence;
00040 
00041 // forward declaration of the ClusterSequenceWrapper
00050 class ClusterSequenceWrapper{
00051 public:
00052   ClusterSequenceWrapper() : _cs(NULL){};
00053   ClusterSequenceWrapper(ClusterSequence *cs) : _cs(cs){};
00054 
00055   const ClusterSequence * cs() const { return _cs;}
00056   ClusterSequence * non_const_cs() const { return _cs;}
00057   bool is_alive() const { return (_cs != NULL);}
00058 
00059   friend class ClusterSequence;
00060 
00061 private:
00062   ClusterSequence * _cs;
00063 };
00064 
00065 FASTJET_END_NAMESPACE
00066 
00067 #endif  //  __FASTJET_CLUSTER_SEQUENCE_WRAPPER_HH__