GET library
GETProcessSerie Class Reference

#include <GETProcessSerie.hh>

Inheritance diagram for GETProcessSerie:
GETProcess

Public Member Functions

Constructors, affectation, destructor
 GETProcessSerie (GETObject &obj)
 
 GETProcessSerie (u_int n=0, double dt=0.01)
 
 GETProcessSerie (const GETProcessSerie &proc)
 
virtual ~GETProcessSerie ()
 
Managing the list of processes
virtual GETProcessAddProcess (GETProcess *ptr)
 
virtual GETProcessAddProcess (GETProcess &obj)
 
Signal processing
virtual GETSampleProcessSample (GETChannel &channel, u_short info)
 
virtual GETSampleProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
 
ROOT related functions
 ClassDef (GETProcessSerie, 0)
 
- Public Member Functions inherited from GETProcess
 GETProcess (GETObject &obj)
 
 GETProcess (u_int n=0, double dt=0.01)
 
 GETProcess (const GETProcess &proc)
 
virtual ~GETProcess ()
 
virtual void SetOptions (u_int opts)
 
virtual void SetOption (u_int flags, bool b=true)
 
virtual u_int GetOptions ()
 
virtual bool GetOption (u_int flags)
 
virtual void Init (u_int n, double dt)
 
u_int GetDimension () const
 
double GetSamplingTime () const
 
GETSampleGetResultSamplePtr ()
 
const GETSampleGetResultSamplePtr () const
 
GETSampleGetResultSample ()
 
const GETSampleGetResultSample () const
 
 ClassDef (GETProcess, 0)
 

Private Member Functions

 GObject (GETProcessSerie)
 

Additional Inherited Members

- Protected Attributes inherited from GETProcess
u_int options
 Option flags.
 
GETSample result_sample
 Internal processing result sample (processing result)
 

Detailed Description

GETProcessSerie defines a list of processes to be applyied sequentially. Actually the class is a list of GETProcessLink objects, not of GETProcess, so that each process added can be added either locally or externally.

Constructor & Destructor Documentation

GETProcessSerie::GETProcessSerie ( GETObject obj)

Constructor: the dimension of the first channel of the object is used for the process definition.

Parameters
obja core object of the GET system
GETProcessSerie::GETProcessSerie ( u_int  n = 0,
double  dt = 0.01 
)

Constructor.

Parameters
nsampling size of the channels
dtsampling period (us)
GETProcessSerie::GETProcessSerie ( const GETProcessSerie proc)

Copy constructor.

Parameters
procobject to copy
GETProcessSerie::~GETProcessSerie ( )
virtual

Destructor.

Member Function Documentation

GETProcess * GETProcessSerie::AddProcess ( GETProcess ptr)
virtual

Add a process to the list. A GETProcessLink object is created for the process, that is considered local (the process pointer is adopted).

Parameters
ptrpointer to the process object

References GETProcessLink::GetProcess().

Referenced by GETObject::AddOutputCorrection().

GETProcess * GETProcessSerie::AddProcess ( GETProcess obj)
virtual

Add a process to the list. A GETProcessLink object is created for the process, that is considered local (the process pointer is adopted).

Parameters
objprocess object

References GETProcessLink::GetProcess().

GETProcessSerie::ClassDef ( GETProcessSerie  ,
 
)

for use within ROOT.

GETProcessSerie::GObject ( GETProcessSerie  )
private

Macro from GCpp library that defines the following functions:

  • ClassName(): return the real class name of the object
  • StaticClassName(): return the used class name of the object (that may be a base class of the real object).
  • IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
  • Clone(): return an allocated copy of the object.
GETSample * GETProcessSerie::ProcessSample ( GETChannel channel,
u_short  info 
)
virtual

This function processes the argument channel and stores the result in the internal sample.

The channel sample that is processed depends on the info argument:

  • if info == GET::signalTst, the channel input test sample is processed
  • if info == GET::signalOut, the channel output sample is processed The function returns the internal result sample pointer. In case of error, the result is a NULL pointer.
Note
The channel samples are not modified, the result is stored in the process internal sample.
Parameters
channelGET system channel to be processed
infoadditional optional information (sample signal identifier)

Implements GETProcess.

References GETChannel::OutSample(), GETProcess::result_sample, GET::signalTst, and GETChannel::TstSample().

GETSample * GETProcessSerie::ProcessSample ( GETSample sample,
GETSample result,
GETChannel channel 
)
virtual

This is the effective function that processes the input sample and stores the result in the result sample. All processes from the list are applied sequentially.

Note
  • The sample to be processed and the result sample can be the same object, in which case the initial sample is replaced by the processing result.
  • The initial and result samples may be the same object, in which case the sample is replaced by the result.
Parameters
sampleinput sample to be processed
resultsample where result should be stored
channelGET system channel (the samples should correspond to this channel)

Implements GETProcess.

References GETObject::GetFullId(), and GETProcess::ProcessSample().


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