DataMethod< DataType > Class Template Reference

#include <DataMethod.hxx>

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

List of all members.

Public Member Functions

 DataMethod ()
virtual ~DataMethod ()
 Virtual destructor.
const std::string & getName () const
void logInfo (const StringMap &aTarget)
 Helper function to log information on the instantiated DataMethod.
bool useOtherTables (IntMap &sourceTbl, int tabNo)
void determineSourceAndTarget (const TableInfo &aInfo, const StringMap &aTarget)
bool determineDetectionSourceAndTarget (const TableInfo *aInfo, int tabNo, const StringMap &aTarget)
virtual void setSource (IntMap &tbls, IntMap &cols, StringMap units)=0
virtual void setTarget (IntMap &cols, StringMap units)=0
virtual void doit (TableData< DataType > &data, int row1, int row2)=0
virtual void doit2 (TableData< DataType > &inpData, TableData< DataType > &data, int row1, int row2)=0

Protected Attributes

std::string methodName
 The name given to a data method.

Detailed Description

template<typename DataType>
class DataMethod< DataType >

Abstract base class for data method class. A data method is a function of one or more "source" attributes in a table resulting in one or more "target" attributes. The design of this class is based upon the "Command" pattern in the Design Patterns book (p233).


Constructor & Destructor Documentation

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

Constructor in the base class sets the default value for the methodName. This value can be overwritten in the constructors of the derived classes.

References DataMethod< DataType >::methodName.

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

Virtual destructor.


Member Function Documentation

template<typename DataType>
bool DataMethod< DataType >::determineDetectionSourceAndTarget ( const TableInfo aInfo,
int  tabNo,
const StringMap aTarget 
) [inline]
template<typename DataType>
void DataMethod< DataType >::determineSourceAndTarget ( const TableInfo aInfo,
const StringMap aTarget 
) [inline]
template<typename DataType>
virtual void DataMethod< DataType >::doit ( TableData< DataType > &  data,
int  row1,
int  row2 
) [pure virtual]
template<typename DataType>
virtual void DataMethod< DataType >::doit2 ( TableData< DataType > &  inpData,
TableData< DataType > &  data,
int  row1,
int  row2 
) [pure virtual]
template<typename DataType>
const std::string& DataMethod< DataType >::getName (  )  const [inline]

Return the name of the data method. The appropriate value as defined in subclasses will be returned.

References DataMethod< DataType >::methodName.

template<typename DataType>
void DataMethod< DataType >::logInfo ( const StringMap aTarget  )  [inline]
template<typename DataType>
virtual void DataMethod< DataType >::setSource ( IntMap tbls,
IntMap cols,
StringMap  units 
) [pure virtual]
template<typename DataType>
virtual void DataMethod< DataType >::setTarget ( IntMap cols,
StringMap  units 
) [pure virtual]
template<typename DataType>
bool DataMethod< DataType >::useOtherTables ( IntMap sourceTbl,
int  tabNo 
) [inline]

Member Data Documentation

template<typename DataType>
std::string DataMethod< DataType >::methodName [protected]

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