COSC-4P82-Final-Project/lib/beagle-3.0.3/beagle/include/beagle/AbstractAllocT.hpp

102 lines
3.1 KiB
C++

/*
* Open BEAGLE
* Copyright (C) 2001-2007 by Christian Gagne and Marc Parizeau
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Contact:
* Laboratoire de Vision et Systemes Numeriques
* Departement de genie electrique et de genie informatique
* Universite Laval, Quebec, Canada, G1K 7P4
* http://vision.gel.ulaval.ca
*
*/
/*!
* \file beagle/AbstractAllocT.hpp
* \brief Definition of abstract templated class AbstractAllocT.
* \author Christian Gagne
* \author Marc Parizeau
* $Revision: 1.4.2.1 $
* $Date: 2007/05/09 01:51:08 $
*/
#ifndef Beagle_AbstractAllocT_hpp
#define Beagle_AbstractAllocT_hpp
#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/Allocator.hpp"
#include "beagle/PointerT.hpp"
#include "beagle/AllocatorT.hpp"
namespace Beagle {
/*!
* \class AbstractAllocT beagle/AbstractAllocT.hpp "beagle/AbstractAllocT.hpp"
* \brief Abstract templated allocator class.
* \param T Type (abtsract) of object allocated.
* \param BaseType Base type from which the actual allocator type is derived.
* \ingroup OOF
* \ingroup Allocs
* \par Note:
* This class is usually used to define the Alloc type of an abstract Beagle class.
*/
template <class T, class BaseType>
class AbstractAllocT : public BaseType {
public:
//! AbstractAllocT allocator type.
typedef AbstractAllocT<AbstractAllocT<T,BaseType>,typename BaseType::Alloc>
Alloc;
//! AbstractAllocT handle type.
typedef PointerT<AbstractAllocT<T,BaseType>,typename BaseType::Handle>
Handle;
//! AbstractAllocT bag type.
typedef ContainerT<AbstractAllocT<T,BaseType>,typename BaseType::Bag>
Bag;
AbstractAllocT() { }
virtual ~AbstractAllocT() { }
/*!
* \brief Allocate a new object on the heap.
* \return Pointer to the allocated object.
*/
virtual Object* allocate() const =0;
/*!
* \brief Allocate a new object on the heap that is a clone an existing object.
* \param inOrigObj Constant reference to the original object to clone.
* \return Pointer to the allocated object.
*/
virtual Object* clone(const Object& inOrigObj) const =0;
/*!
* \brief Copy an object into another.
* \param inOrigObj Constant reference to the original object to copy.
* \param outCopyObj Reference to the object that is a copy of the original.
*/
virtual void copy(Object& outCopyObj, const Object& inOrigObj) const =0;
};
}
#endif // Beagle_AbstractAllocT_hpp