datatools::i_cloneable Class Reference

A pure abstract class (interface) for inherited cloneable classes. More...

#include <bayeux/datatools/i_cloneable.h>

Inheritance diagram for datatools::i_cloneable:

Public Member Functions
virtual i_cloneable *	clone (void) const =0
virtual	~i_cloneable ()
template<class CandidateType >
bool	is_cloneable (const CandidateType &candidate_)

Static Public Member Functions
template<class Copyable >
static Copyable *	clone_it (const Copyable &a_copyable)

Detailed Description

A pure abstract class (interface) for inherited cloneable classes.

This is a pure abstract class that can be inherited for class cloning service (only for copyable objects).

Some macros are provided for declaration and definition of a clone method within a class. Should be in public scope.

Example:

Header file (my_data.h):

#include <datatools/i_cloneable.h>

class my_data : public datatools::i_cloneable {
 public:
  DATATOOLS_CLONEABLE_DECLARATION(my_data)
};

Implementation file (my_data.cc):

#include <my_data.h>

DATATOOLS_CLONEABLE_IMPLEMENTATION(my_data)

The my_data class must have a copy constructor (or a default copy constructor provided by the compiler).

Constructor & Destructor Documentation

~i_cloneable()

virtual datatools::i_cloneable::~i_cloneable ( )

inlinevirtual

The virtual destructor

Member Function Documentation

clone()

virtual i_cloneable* datatools::i_cloneable::clone ( void  ) const

pure virtual

A pure virtual member.

Returns

a pointer to a new instance of a cloneable class.

clone_it()

template<class Copyable >

static Copyable* datatools::i_cloneable::clone_it ( const Copyable &  a_copyable )

inlinestatic

Templatized static method for cloning copyable objects.

is_cloneable()

template<class CandidateType >

bool datatools::i_cloneable::is_cloneable ( const CandidateType &  candidate_ )

inline

---

The documentation for this class was generated from the following file:

• bayeux/datatools/i_cloneable.h