AmpTools
UserDataReader< T > Class Template Reference

#include <UserDataReader.h>

Inheritance diagram for UserDataReader< T >:
Collaboration diagram for UserDataReader< T >:

Public Member Functions

 UserDataReader ()
 
 UserDataReader (const vector< string > &args)
 
virtual ~UserDataReader ()
 
virtual DataReadernewDataReader (const vector< string > &args) const
 
virtual DataReaderclone () const
 
- Public Member Functions inherited from DataReader
 DataReader ()
 
 DataReader (const vector< string > &args)
 
virtual ~DataReader ()
 
virtual KinematicsgetEvent ()=0
 
virtual void resetSource ()=0
 
virtual unsigned int numEvents () const =0
 
virtual string name () const =0
 
virtual vector< string > arguments () const
 
virtual bool isDefault () const
 

Detailed Description

template<class T>
class UserDataReader< T >

This class handles the creation and cloning of the user's data reader.

It is intended that the user writes a functional data reader that inherits from this class (and thus the DataReader base class through this class) and also defines the necessary virtual member functions for accessing data.

Definition at line 58 of file UserDataReader.h.

Constructor & Destructor Documentation

◆ UserDataReader() [1/2]

template<class T >
UserDataReader< T >::UserDataReader ( )
inline

This is the default constructor. It should be called in the default constructor of the user's derived class.

Definition at line 67 of file UserDataReader.h.

◆ UserDataReader() [2/2]

template<class T >
UserDataReader< T >::UserDataReader ( const vector< string > &  args)
inline

This constructor takes a list of arguments and stores them. There should be a corresponding constructor in the user's derived class that calls this constructor.

Definition at line 75 of file UserDataReader.h.

◆ ~UserDataReader()

template<class T >
virtual UserDataReader< T >::~UserDataReader ( )
inlinevirtual

This is the destructor.

Definition at line 81 of file UserDataReader.h.

Member Function Documentation

◆ clone()

template<class T >
virtual DataReader* UserDataReader< T >::clone ( ) const
inlinevirtual

This method can create a clone of a data reader (of the derived type).

Implements DataReader.

Definition at line 95 of file UserDataReader.h.

◆ newDataReader()

template<class T >
virtual DataReader* UserDataReader< T >::newDataReader ( const vector< string > &  args) const
inlinevirtual

This method can create a new data reader (of the derived type).

Implements DataReader.

Definition at line 87 of file UserDataReader.h.


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