lsst::afw::table::io::Reader Class Reference

A base class for code that reads table/record data from another source. More...

#include <Reader.h>

Inheritance diagram for lsst::afw::table::io::Reader:

Public Member Functions
template<typename ContainerT >
ContainerT	read ()
	Load an on-disk table into a container. More...
virtual	~Reader ()

Protected Member Functions
virtual boost::shared_ptr < BaseTable >	_readTable ()=0
	Create a new table of the appropriate type. More...
virtual boost::shared_ptr < BaseRecord >	_readRecord (boost::shared_ptr< BaseTable > const &table)=0
	Read an individual record, creating it with the given table. More...

Detailed Description

A base class for code that reads table/record data from another source.

An instance of Reader is associated with a particular file or other data source, and can be invoked simply by calling read() with no arguments and a template parameter that corresponds to the specialized container into which records will be loaded.

Reader provides driver code that should work for most input operations and record containers, and delegates the real work to its protected member functions. Reader does not specify how it will be constructed.

Definition at line 24 of file Reader.h.

Constructor & Destructor Documentation

virtual lsst::afw::table::io::Reader::~Reader ( )

inlinevirtual

Definition at line 66 of file Reader.h.

{}

Member Function Documentation

virtual boost::shared_ptr< BaseRecord > lsst::afw::table::io::Reader::_readRecord ( boost::shared_ptr< BaseTable > const &  table )

protectedpure virtual

Read an individual record, creating it with the given table.

The result may be an instance of a subclass of BaseRecord. The table will have just been loaded with _readSchema; these are separated in order to allow subclasses to delegate to base class implementations more effectively.

Implemented in lsst::afw::table::io::FitsReader.

virtual boost::shared_ptr< BaseTable > lsst::afw::table::io::Reader::_readTable ( )

protectedpure virtual

Create a new table of the appropriate type.

The result may be an instance of a subclass of BaseTable.

Implemented in lsst::afw::table::io::FitsReader.

template<typename ContainerT >

ContainerT lsst::afw::table::io::Reader::read ( )

inline

Load an on-disk table into a container.

The container must be a specialized table container (like CatalogT):

• It must be constructable from a single table shared_ptr argument.
• It must have an insert member function that takes an position iterator and a record shared_ptr.

Definition at line 36 of file Reader.h.

                      {
#if 1
        // Work around a clang++ version 3.0 (tags/Apple/clang-211.12) bug with shared_ptr reference counts
        PTR(typename ContainerT::Table) table;
        {
            PTR(BaseTable) tmpTable = _readTable();
            table = boost::dynamic_pointer_cast<typename ContainerT::Table>(tmpTable);
        }
#else
        PTR(typename ContainerT::Table) table 
            = boost::dynamic_pointer_cast<typename ContainerT::Table>(_readTable());
#endif
        if (!table) {
            throw LSST_EXCEPT(
                lsst::pex::exceptions::RuntimeError,
                "Container's table type is not compatible with on-disk table type."
            );
        }
        ContainerT container(table);
        PTR(BaseRecord) record = _readRecord(table);
        while (record) {
            container.insert(
                container.end(),
                boost::static_pointer_cast<typename ContainerT::Record>(record)
            );
            record = _readRecord(table);
        }
        return container;
    }

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/table/io/Reader.h