DataBuilder< DataType > Class Template Reference

#include <DataBuilder.hxx>

Inheritance diagram for DataBuilder< DataType >:
Inheritance graph
[legend]
Collaboration diagram for DataBuilder< DataType >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 DataBuilder ()
 Constructor.
virtual ~DataBuilder ()
 Virtual destructor.
const std::string & getName () const
void logInfo (const std::string &aTableName)
 Helper function to information on the instantiated Databuilder.
virtual TableData< DataType > * build (FitsFile &fpix, FitsFile &fcat, int fileNo)=0

Protected Attributes

std::string builderName

Detailed Description

template<typename DataType>
class DataBuilder< DataType >

Abstract base class for data builder class. The derived classes of this base class represent the various types of tables in the database. Each derived class provides the necessary specialised implementation particular to its corresponding table type. The design of this class was inspired by the "Builder" design pattern


Constructor & Destructor Documentation

template<typename DataType>
DataBuilder< DataType >::DataBuilder (  )  [inline]

Constructor.

References DataBuilder< DataType >::builderName.

template<typename DataType>
virtual DataBuilder< DataType >::~DataBuilder (  )  [inline, virtual]

Virtual destructor.


Member Function Documentation

template<typename DataType>
virtual TableData<DataType>* DataBuilder< DataType >::build ( FitsFile fpix,
FitsFile fcat,
int  fileNo 
) [pure virtual]

Interface definition for the build function. This will return an object corresponding to an instance of the TableData class. The object will be filled with data extracted from the given FitsFile objects. An additional input is the file number in the input list. Note that this function as defined in this class doesn't do anything. The actual implementation details appropriate for a particular type of table are given in the derived sub-classes.

Implemented in Catalog< DataType >, Extension< DataType >, Primary< DataType >, and Provenance< DataType >.

Referenced by extractMetadata(), and extractSources().

template<typename DataType>
const std::string& DataBuilder< DataType >::getName (  )  const [inline]
template<typename DataType>
void DataBuilder< DataType >::logInfo ( const std::string &  aTableName  )  [inline]

Helper function to information on the instantiated Databuilder.

References Logger::addMessage(), and DataBuilder< DataType >::builderName.

Referenced by extractMetadata(), and extractSources().


Member Data Documentation

template<typename DataType>
std::string DataBuilder< DataType >::builderName [protected]

The documentation for this class was generated from the following file:
Generated on Mon Oct 4 10:39:23 2010 for WfcamSrc by  doxygen 1.6.3