OutputArchive.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
#ifndef AFW_TABLE_IO_OutputArchive_h_INCLUDED
#define AFW_TABLE_IO_OutputArchive_h_INCLUDED

#include "lsst/base.h"
#include "lsst/afw/table/io/Persistable.h"

namespace lsst { namespace afw { namespace table {

class Schema;
class BaseRecord;
template <typename RecordT> class CatalogT;
typedef CatalogT<BaseRecord> BaseCatalog;

namespace io {

class Persistable;
class OutputArchiveHandle;

class OutputArchive {
public:

    friend class OutputArchiveHandle;

    OutputArchive();

    OutputArchive(OutputArchive const & other);

    OutputArchive & operator=(OutputArchive const & other);

    // (trivial) destructor must be defined in the source for pimpl idiom.
    ~OutputArchive();


    int put(Persistable const * obj, bool permissive=false);
    int put(CONST_PTR(Persistable) obj, bool permissive=false) { return put(obj.get(), permissive); }

    BaseCatalog const & getIndexCatalog() const;

    BaseCatalog const & getCatalog(int n) const;

    int countCatalogs() const;

    void writeFits(fits::Fits & fitsfile) const;

private:

    class Impl;

    PTR(Impl) _impl;
};

class OutputArchiveHandle {
public:

    BaseCatalog makeCatalog(Schema const & schema);

    void saveCatalog(BaseCatalog const & catalog);


    int put(Persistable const * obj, bool permissive=false);
    int put(CONST_PTR(Persistable) obj, bool permissive=false) { return put(obj.get(), permissive); }

    ~OutputArchiveHandle();

    // No copying
    OutputArchiveHandle (const OutputArchiveHandle&) = delete;
    OutputArchiveHandle& operator=(const OutputArchiveHandle&) = delete;

    // No moving
    OutputArchiveHandle (OutputArchiveHandle&&) = delete;
    OutputArchiveHandle& operator=(OutputArchiveHandle&&) = delete;

private:

    friend class OutputArchive::Impl;

    OutputArchiveHandle(
        int id, std::string const & name, std::string const & module,
        PTR(OutputArchive::Impl) impl
    );

    int _id;
    int _catPersistable;
    std::string _name;
    std::string _module;
    PTR(OutputArchive::Impl) _impl;
};

}}}} // namespace lsst::afw::table::io

#endif // !AFW_TABLE_IO_OutputArchive_h_INCLUDED