Persistable.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 3 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 LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_DAF_BASE_PERSISTABLE_H
#define LSST_DAF_BASE_PERSISTABLE_H

#include <boost/shared_ptr.hpp>
#include <typeinfo>

namespace lsst {
namespace daf {
namespace base {

// Forward declarations.
class Persistable;

} // namespace lsst::daf::base

namespace persistence {
// Template global function used to connect with boost::serialization.
// Definition is in daf/persistence/FormatterImpl.h, but is not needed by
// Persistable clients, only Formatter subclasses.
template <class Form, class Archive>
    void delegateSerialize(Archive& ar, unsigned int const version,
                           lsst::daf::base::Persistable* persistable);

} // namespace lsst::daf::persistence

namespace base {

class Persistable {
public:
    typedef boost::shared_ptr<Persistable> Ptr;

    Persistable(void);
    virtual ~Persistable(void);

    template <class Archive>
    void serialize(Archive& , unsigned int const) { }
};

#define LSST_PERSIST_FORMATTER(formatter...) \
    friend class boost::serialization::access; \
    friend class formatter; \
    template <class Archive> \
    void serialize(Archive& ar, unsigned int const version) { \
        lsst::daf::persistence::delegateSerialize<formatter, Archive>(ar, version, this); \
    }

}}} // namespace lsst::daf::base

// Forward declaration of the boost::serialization::access class.
namespace boost {
namespace serialization {
class access;
}} // namespace boost::serialization

#endif