CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Static Public Member Functions | List of all members
cass::ACQIRIS::SignalExtractor Class Referenceabstract

Base class for classes that extract Signals from recorded data. More...

#include <signal_extractor.h>

+ Inheritance diagram for cass::ACQIRIS::SignalExtractor:

Public Member Functions

virtual ~SignalExtractor ()
 virtual destructor More...
 
virtual SignalProducer::signals_toperator() (SignalProducer::signals_t &sig)=0
 retrieve signals from data More...
 
virtual void associate (const CASSEvent &evt)=0
 associate the event with this analyzer More...
 
virtual void loadSettings (CASSSettings &s)=0
 load the settings of the extractor More...
 

Static Public Member Functions

static std::tr1::shared_ptr< SignalExtractorinstance (SignalExtractorType type)
 creates an instance of the requested extractor type More...
 

Detailed Description

Base class for classes that extract Signals from recorded data.

All classes that want to extract signals from the data, should inherit from this class. This classes operator will be called by the signal producers, that want to have theier singals extracted from the data.

Author
Lutz Foucar

Definition at line 33 of file signal_extractor.h.

Constructor & Destructor Documentation

virtual cass::ACQIRIS::SignalExtractor::~SignalExtractor ( )
inlinevirtual

virtual destructor

Definition at line 37 of file signal_extractor.h.

Member Function Documentation

virtual void cass::ACQIRIS::SignalExtractor::associate ( const CASSEvent evt)
pure virtual

associate the event with this analyzer

retrieve all necessary information from the event to be able to later extract the signals from the data. Needs to be implemented by the class that implements the extractor method.

Parameters
evtthe event the signals are extracted from

Implemented in cass::ACQIRIS::CFD16Bit, cass::ACQIRIS::CoM16Bit, cass::ACQIRIS::CFD8Bit, cass::ACQIRIS::CoM8Bit, and cass::ACQIRISTDC::TDCExtractor.

std::tr1::shared_ptr< SignalExtractor > cass::ACQIRIS::SignalExtractor::instance ( SignalExtractorType  type)
static

creates an instance of the requested extractor type

this static member will create an instance of the requested type, which is a class that inherits from this. If the requested type is unknown, an invalid_argument exception will be thrown.

Returns
shared_ptr to the instance of the requested type
Parameters
typeThe type of signal extractor that the user requests

Definition at line 21 of file signal_extractor.cpp.

References cass::ACQIRIS::cfd16, cass::ACQIRIS::cfd8, cass::ACQIRIS::com16, cass::ACQIRIS::com8, cass::ACQIRIS::tdcextractor, and cass::toString().

Referenced by cass::ACQIRIS::SignalProducer::loadSettings().

virtual void cass::ACQIRIS::SignalExtractor::loadSettings ( CASSSettings s)
pure virtual

load the settings of the extractor

load the settings form the .ini file. Needs to be implementd by the class that implements the signal extractor.

Parameters
sthe CASSSettings object to retrieve the information from.

Implemented in cass::ACQIRIS::CFD16Bit, cass::ACQIRIS::CoM16Bit, cass::ACQIRIS::CFD8Bit, cass::ACQIRIS::CoM8Bit, and cass::ACQIRISTDC::TDCExtractor.

virtual SignalProducer::signals_t& cass::ACQIRIS::SignalExtractor::operator() ( SignalProducer::signals_t sig)
pure virtual

retrieve signals from data

extract signals form the CASSEvent. Needs to be implemented by the classes that inerhit from this.

Returns
reference of the input result container
Parameters
[in]sigthis is the container for the results

Implemented in cass::ACQIRIS::CFD16Bit, cass::ACQIRIS::CoM16Bit, cass::ACQIRIS::CFD8Bit, cass::ACQIRIS::CoM8Bit, and cass::ACQIRISTDC::TDCExtractor.


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