lsst::afw::table::io::Writer Class Reference

Write a container of records to disk (or elsewhere). More...

#include <Writer.h>

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

Public Member Functions
template<typename ContainerT >
void	write (ContainerT const &container)
	Write records in a container to disk (or elsewhere). More...
virtual	~Writer ()

Protected Member Functions
virtual void	_writeTable (boost::shared_ptr< BaseTable const > const &table, std::size_t nRows)=0
	Write a table and its schema. More...
virtual void	_writeRecord (BaseRecord const &record)=0
	Write an individual record. More...
virtual void	_finish ()
	Finish writing a catalog. More...

Detailed Description

Write a container of records to disk (or elsewhere).

An instance of Writer is associated with a particular file or storage location, and can be invoked by calling write() with a container.

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

Definition at line 27 of file Writer.h.

Constructor & Destructor Documentation

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

inlinevirtual

Definition at line 61 of file Writer.h.

{}

Member Function Documentation

virtual void lsst::afw::table::io::Writer::_finish ( )

inlineprotectedvirtual

Finish writing a catalog.

Definition at line 72 of file Writer.h.

{}

virtual void lsst::afw::table::io::Writer::_writeRecord ( BaseRecord const &  record )

protectedpure virtual

Write an individual record.

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

virtual void lsst::afw::table::io::Writer::_writeTable ( boost::shared_ptr< BaseTable const > const &  table, std::size_t  nRows  )

protectedpure virtual

Write a table and its schema.

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

template<typename ContainerT >

void lsst::afw::table::io::Writer::write ( ContainerT const &  container )

inline

Write records in a container to disk (or elsewhere).

The given container must have a getTable() member function that returns a shared_ptr to a table, and the iterators returned by begin() and end() must dereference to a type convertible to BaseRecord const &.

Definition at line 38 of file Writer.h.

                                             {
        std::set<PTR(BaseTable const)> tables;
        for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
            if (i->getTable() != container.getTable()) tables.insert(i->getTable());
        }
        for (std::set<PTR(BaseTable const)>::iterator j = tables.begin(); j != tables.end(); ++j) {
            if (
                (**j).getSchema().compare(container.getTable()->getSchema(), Schema::IDENTICAL)
                != Schema::IDENTICAL
            ) {
                throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Cannot save Catalog with heterogenous schemas"
                );
            }
        }
        _writeTable(container.getTable(), container.size());
        for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
            _writeRecord(*i);
        }
        _finish();
    }

---

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/Writer.h