GET library
GETModifierSeq Class Reference

#include <GETModifierSeq.hh>

Inheritance diagram for GETModifierSeq:
GETSignalModifier GETProcess

Public Member Functions

Constructors, affectation, destructor
 GETModifierSeq (GETSignalModifier *p1=NULL, GETSignalModifier *p2=NULL)
 
 GETModifierSeq (GETSignalModifier &p1, GETSignalModifier &p2)
 
 GETModifierSeq (const GETModifierSeq &proc)
 
virtual ~GETModifierSeq ()
 
Process parameters
const GETSignalModifierGetProcess1 () const
 
GETSignalModifierGetProcess1 ()
 
const GETSignalModifierGetProcess2 () const
 
GETSignalModifierGetProcess2 ()
 
bool IsProcess1Local () const
 
bool IsProcess2Local () const
 
virtual void SetProcess (const GETSignalModifier *proc)
 
virtual void SetProcess (const GETSignalModifier &proc)
 
Signal processing
virtual GETSampleProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
 
ROOT related functions
 ClassDef (GETModifierSeq, 0)
 
- Public Member Functions inherited from GETSignalModifier
 GETSignalModifier (GETObject &obj)
 
 GETSignalModifier (u_int n=0, double dt=0.01)
 
 GETSignalModifier (const GETSignalModifier &proc)
 
virtual ~GETSignalModifier ()
 
virtual GETSampleProcessSample (GETChannel &channel, u_short info)
 
 ClassDef (GETSignalModifier, 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)
 

Protected Attributes

bool local_p1
 Whether process 1 is defined locally.
 
bool local_p2
 Whether process 1 is defined locally.
 
GETSignalModifierprocess1
 First signal modifier.
 
GETSignalModifierprocess2
 Second signal modifier.
 
- Protected Attributes inherited from GETProcess
u_int options
 Option flags.
 
GETSample result_sample
 Internal processing result sample (processing result)
 

Private Member Functions

 GObject (GETModifierSeq)
 

Detailed Description

This class defines a signal modifier that is a sequence of 2 other signal modifiers.

This class is obsolete since the GETProcessSerie has been added.

Constructor & Destructor Documentation

GETModifierSeq::GETModifierSeq ( GETSignalModifier p1 = NULL,
GETSignalModifier p2 = NULL 
)

Constructor. The pointers are adopted, and deleted with the class destructor.

Parameters
p1first signal modifier
p2second signal modifier

References local_p1, local_p2, process1, process2, and SetProcess().

GETModifierSeq::GETModifierSeq ( GETSignalModifier p1,
GETSignalModifier p2 
)

Constructor. The objects are not adopted, and left undestroyed by the class destructor.

Parameters
p1first signal modifier
p2second signal modifier

References local_p1, local_p2, process1, process2, and SetProcess().

GETModifierSeq::GETModifierSeq ( const GETModifierSeq proc)

Copy constructor.

Parameters
procobject to copy

References GetProcess1(), GetProcess2(), IsProcess1Local(), IsProcess2Local(), local_p1, local_p2, process1, process2, and SetProcess().

GETModifierSeq::~GETModifierSeq ( )
virtual

Destructor.

References local_p1, local_p2, process1, and process2.

Member Function Documentation

GETModifierSeq::ClassDef ( GETModifierSeq  ,
 
)

for use within ROOT.

const GETSignalModifier * GETModifierSeq::GetProcess1 ( ) const
inline

Return the pointer to the first signal modifier process.

References process1.

Referenced by GETModifierSeq().

GETSignalModifier * GETModifierSeq::GetProcess1 ( )
inline

Return the pointer to the first signal modifier process.

References process1.

const GETSignalModifier * GETModifierSeq::GetProcess2 ( ) const
inline

Return the pointer to the second signal modifier process.

References process2.

Referenced by GETModifierSeq().

GETSignalModifier * GETModifierSeq::GetProcess2 ( )
inline

Return the pointer to the second signal modifier process.

References process2.

GETModifierSeq::GObject ( GETModifierSeq  )
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.
bool GETModifierSeq::IsProcess1Local ( ) const
inline

Return true if the first signal modifier process is defined locally (adopted by the object).

References local_p1.

Referenced by GETModifierSeq().

bool GETModifierSeq::IsProcess2Local ( ) const
inline

Return true if the second signal modifier process is defined locally (adopted by the object).

References local_p2.

Referenced by GETModifierSeq().

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

This function process the input sample channel and stores the result in the result sample (convolution or deconvolution of the response function, according to inv argument).

The function returns the (argument) result sample sample pointer. In case of error, the result is a NULL pointer.

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 (no use in this class)

Implements GETSignalModifier.

References process1, process2, and GETSignalModifier::ProcessSample().

void GETModifierSeq::SetProcess ( const GETSignalModifier proc)
virtual

Set a process: the pointer is adopted.

Parameters
procpointer to the process

References local_p1, local_p2, process1, and process2.

Referenced by GETModifierSeq().

void GETModifierSeq::SetProcess ( const GETSignalModifier proc)
virtual

Set a process: the object is adopted.

Parameters
procprocess object

References GETProcess::GetDimension(), GETProcess::GetResultSample(), GETProcess::GetSamplingTime(), GETProcess::Init(), local_p1, local_p2, process1, and process2.


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