/* -*- mona-c++ -*-
* Copyright (c) Leipzig, Madrid 2004 - 2008
* Max-Planck-Institute for Human Cognitive and Brain Science
* Max-Planck-Institute for Evolutionary Anthropology
* BIT, ETSI Telecomunicacion, UPM
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
// $Id: RefBase.hh 887 2006-03-01 12:22:14Z write1 $
/*! \brief A basic reference -counting mechanism
A class to provide a basic reference -counting mechanism.
At construction time, the reference count is zero.
References can be added and released. If the reference count
at a release drops below 1, the object is deleted
A reference counted class for large data fields.
\file RefBase.hh
\author Gert Wollny <wollny@cbs.mpg.de>
*/
#ifndef __MONA_REFBASE_HH
#define __MONA_REFBASE_HH 1
//#pragma interface
namespace mona {
class CRefCountedBase {
public:
/// contructor sets the refcount to zero
CRefCountedBase();
/// copy constructor ensured, the copy has no reference
CRefCountedBase(const CRefCountedBase& orig);
/// increase the reference count by one
void add_ref();
/** decrease the reference count by one, if the count drops to zero (or below) the
object will be discarded */
void release();
/** returnd the actual reference count of the object */
int get_refcount();
/**
Check whether the reference count is one.
\returns true if reference count is one, else false.
*/
bool is_single_ref();
protected:
virtual ~CRefCountedBase();
private:
int m_refcount;
};
/**
A function which ensures, that the \a ref_data object \a refered .
\param refered object to make a single referenced one
*/
template <class ref_data >
inline void ensure_single_refered(ref_data* &refered)
{
if (refered->is_single_ref())
return;
ref_data *help = new ref_data(*refered);
refered->release();
refered = help;
refered->add_ref();
}
} // namespace mona
/* CVS LOG
$Log$
Revision 1.4 2005/06/29 13:22:20 wollny
switch to version 0.7
Revision 1.1.1.1 2005/03/17 13:44:20 gerddie
initial import
Revision 1.3 2004/08/25 09:08:31 wollny
added an emacs style comment to all source files
Revision 1.2 2004/06/03 09:57:32 wollny
Changed (hopefully) all instancable class names to Cxxxxx
Revision 1.1.1.1 2004/02/11 18:18:05 tittge
start project
*/
#endif