LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst::afw::table::io::FitsColumnReader Class Referenceabstract

Polymorphic reader interface used to read different kinds of objects from one or more FITS binary table columns. More...

#include <FitsSchemaInputMapper.h>

Inheritance diagram for lsst::afw::table::io::FitsColumnReader:
lsst::afw::table::PersistableObjectColumnReader< T, Setter >

Public Member Functions

 FitsColumnReader () noexcept=default
 
 FitsColumnReader (FitsColumnReader const &)=delete
 
 FitsColumnReader (FitsColumnReader &&)=delete
 
FitsColumnReaderoperator= (FitsColumnReader const &)=delete
 
FitsColumnReaderoperator= (FitsColumnReader &&)=delete
 
virtual void prepRead (std::size_t firstRow, std::size_t nRows, fits::Fits &fits)
 Optionally read ahead and cache values from multiple rows. More...
 
virtual void readCell (BaseRecord &record, std::size_t row, fits::Fits &fits, std::shared_ptr< InputArchive > const &archive) const =0
 Read values from a single row. More...
 
virtual ~FitsColumnReader () noexcept=default
 

Detailed Description

Polymorphic reader interface used to read different kinds of objects from one or more FITS binary table columns.

Definition at line 20 of file FitsSchemaInputMapper.h.

Constructor & Destructor Documentation

◆ FitsColumnReader() [1/3]

lsst::afw::table::io::FitsColumnReader::FitsColumnReader ( )
defaultnoexcept

◆ FitsColumnReader() [2/3]

lsst::afw::table::io::FitsColumnReader::FitsColumnReader ( FitsColumnReader const &  )
delete

◆ FitsColumnReader() [3/3]

lsst::afw::table::io::FitsColumnReader::FitsColumnReader ( FitsColumnReader &&  )
delete

◆ ~FitsColumnReader()

virtual lsst::afw::table::io::FitsColumnReader::~FitsColumnReader ( )
virtualdefaultnoexcept

Member Function Documentation

◆ operator=() [1/2]

FitsColumnReader& lsst::afw::table::io::FitsColumnReader::operator= ( FitsColumnReader const &  )
delete

◆ operator=() [2/2]

FitsColumnReader& lsst::afw::table::io::FitsColumnReader::operator= ( FitsColumnReader &&  )
delete

◆ prepRead()

virtual void lsst::afw::table::io::FitsColumnReader::prepRead ( std::size_t  firstRow,
std::size_t  nRows,
fits::Fits fits 
)
inlinevirtual

Optionally read ahead and cache values from multiple rows.

Subclasses are not required to implement this method; if they do, they should indicate to readCell that cached values should be used instead. Subclasses should not assume that prepRead will always be called, however.

Parameters
[in]firstRowIndex of the first row to read.
[in]nRowsNumber of rows to read.
[in]fitsFITS file manager object.

Definition at line 42 of file FitsSchemaInputMapper.h.

42 {}

◆ readCell()

virtual void lsst::afw::table::io::FitsColumnReader::readCell ( BaseRecord record,
std::size_t  row,
fits::Fits fits,
std::shared_ptr< InputArchive > const &  archive 
) const
pure virtual

Read values from a single row.

Parameters
[in,out]recordRecord to populate.
[in]rowIndex of the row to read from.
[in]fitsFITS file manager object.
[in]archiveArchive holding persisted objects, loaded from other HDUs. May be null.

Implemented in lsst::afw::table::PersistableObjectColumnReader< T, Setter >.


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