Simple.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010, 2011 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 AFW_TABLE_Simple_h_INCLUDED
#define AFW_TABLE_Simple_h_INCLUDED

#include "lsst/afw/table/BaseRecord.h"
#include "lsst/afw/table/BaseTable.h"
#include "lsst/afw/table/IdFactory.h"
#include "lsst/afw/table/Catalog.h"
#include "lsst/afw/table/BaseColumnView.h"
#include "lsst/afw/table/SortedCatalog.h"

namespace lsst { namespace afw { namespace table {

class SimpleRecord;
class SimpleTable;

class SimpleRecord : public BaseRecord {
public:

    typedef SimpleTable Table;
    typedef ColumnViewT<SimpleRecord> ColumnView;
    typedef SortedCatalogT<SimpleRecord> Catalog;
    typedef SortedCatalogT<SimpleRecord const> ConstCatalog;

    CONST_PTR(SimpleTable) getTable() const {
        return boost::static_pointer_cast<SimpleTable const>(BaseRecord::getTable());
    }

    RecordId getId() const;
    void setId(RecordId id);

    IcrsCoord getCoord() const;
    void setCoord(IcrsCoord const & coord);
    void setCoord(Coord const & coord);

    Angle getRa() const;
    void setRa(Angle ra);

    Angle getDec() const;
    void setDec(Angle dec);

protected:

    SimpleRecord(PTR(SimpleTable) const & table);

};

class SimpleTable : public BaseTable {
public:

    typedef SimpleRecord Record;
    typedef ColumnViewT<SimpleRecord> ColumnView;
    typedef SortedCatalogT<Record> Catalog;
    typedef SortedCatalogT<Record const> ConstCatalog;

    static PTR(SimpleTable) make(Schema const & schema, PTR(IdFactory) const & idFactory);

    static PTR(SimpleTable) make(Schema const & schema) { return make(schema, IdFactory::makeSimple()); }

    static Schema makeMinimalSchema() {
        Schema r = getMinimalSchema().schema;
        r.disconnectAliases();
        return r;
    }

    static bool checkSchema(Schema const & other) {
        return other.contains(getMinimalSchema().schema);
    }

    PTR(IdFactory) getIdFactory() { return _idFactory; }

    CONST_PTR(IdFactory) getIdFactory() const { return _idFactory; }

    void setIdFactory(PTR(IdFactory) f) { _idFactory = f; }


    static Key<RecordId> getIdKey() { return getMinimalSchema().id; }
    static Key<Coord> getCoordKey() { return getMinimalSchema().coord; }

    PTR(SimpleTable) clone() const { return boost::static_pointer_cast<SimpleTable>(_clone()); }

    PTR(SimpleRecord) makeRecord() { return boost::static_pointer_cast<SimpleRecord>(_makeRecord()); }

    PTR(SimpleRecord) copyRecord(BaseRecord const & other) {
        return boost::static_pointer_cast<SimpleRecord>(BaseTable::copyRecord(other));
    }

    PTR(SimpleRecord) copyRecord(BaseRecord const & other, SchemaMapper const & mapper) {
        return boost::static_pointer_cast<SimpleRecord>(BaseTable::copyRecord(other, mapper));
    }

protected:

    SimpleTable(Schema const & schema, PTR(IdFactory) const & idFactory);

    SimpleTable(SimpleTable const & other);

private:

    // Struct that holds the minimal schema and the special keys we've added to it.
    struct MinimalSchema {
        Schema schema;
        Key<RecordId> id;
        Key<Coord> coord;

        MinimalSchema();
    };
    
    // Return the singleton minimal schema.
    static MinimalSchema & getMinimalSchema();

    friend class io::FitsWriter;

     // Return a writer object that knows how to save in FITS format.  See also FitsWriter.
    virtual PTR(io::FitsWriter) makeFitsWriter(fits::Fits * fitsfile, int flags) const;

    PTR(IdFactory) _idFactory;        // generates IDs for new records
};

#ifndef SWIG

inline RecordId SimpleRecord::getId() const { return get(SimpleTable::getIdKey()); }
inline void SimpleRecord::setId(RecordId id) { set(SimpleTable::getIdKey(), id); }

inline IcrsCoord SimpleRecord::getCoord() const { return get(SimpleTable::getCoordKey()); }
inline void SimpleRecord::setCoord(IcrsCoord const & coord) { set(SimpleTable::getCoordKey(), coord); }
inline void SimpleRecord::setCoord(Coord const & coord) { set(SimpleTable::getCoordKey(), coord); }

inline Angle SimpleRecord::getRa() const { return get(SimpleTable::getCoordKey().getRa()); }
inline void SimpleRecord::setRa(Angle ra) { set(SimpleTable::getCoordKey().getRa(), ra); }

inline Angle SimpleRecord::getDec() const { return get(SimpleTable::getCoordKey().getDec()); }
inline void SimpleRecord::setDec(Angle dec) { set(SimpleTable::getCoordKey().getDec(), dec); }

#endif // !SWIG

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

#endif // !AFW_TABLE_Simple_h_INCLUDED