Diana Software
Public Member Functions | Private Attributes | List of all members
QTimeNeighbour Class Reference

Neighbours that are neighbours in time. More...

Inheritance diagram for QTimeNeighbour:
QReaderNeighbour QModuleTimeProfiling QSameChannelNeighbour

Public Member Functions

void Init (const QReader &reader)
 Initialzation. More...
 
QReaderNeighbour::NeighbourInfo GetNeighbourInfo (const QEvent &thisEvent, const QEvent &otherEvent)
 Get the neighbour info between two events. More...
 
bool GetWantsNeighbours (const QEvent &thisEvent)
 
- Public Member Functions inherited from QReaderNeighbour
 QReaderNeighbour ()
 
virtual ~QReaderNeighbour ()
 
void InitBase (const QReader &reader)
 
virtual NeighbourInfo GetNeighbourInfoBase (const QEvent &thisEvent, const QEvent &otherEvent)
 
virtual bool GetWantsNeighboursBase (const QEvent &thisEvent)
 
int GetFillStrategy () const
 
- Public Member Functions inherited from QModuleTimeProfiling
 QModuleTimeProfiling ()
 ctor initialized internal variables More...
 
virtual ~QModuleTimeProfiling ()
 dtor does nothing More...
 
void SetTimeProfilingOn (bool val)
 Set the time profiling on/off. More...
 
bool GetTimeProfilingOn () const
 Check if the time profiling is on. More...
 
void ResetTimer ()
 Reset the timer to now. More...
 
double GetTimer () const
 return the time since the last reset More...
 
virtual void StartProcessCall ()
 Start of a process call. More...
 
virtual void EndProcessCall ()
 End a process call and increment time and calls. More...
 
unsigned long long GetProcessCalls () const
 Return the total number of process calls. More...
 
double GetTotalProcessTime () const
 Return the total processing time. More...
 
double GetProcessCallTime () const
 Return the average time of a single process call. More...
 
std::string GetTimeProfileReport (const std::string &prefix="") const
 Report the time profiling. More...
 

Private Attributes

double fWindowSizeMs
 
double fNeighbourDistanceMs
 
double fNeighbourOffsetMs
 
long long fOffsetNs
 
QEventLabel fFiltVar
 

Additional Inherited Members

- Public Types inherited from QReaderNeighbour
enum  FillStrategies { kExhaustiveFillStrategy , kAssociativeFillStrategy , kFilterFillStrategy }
 
- Protected Attributes inherited from QReaderNeighbour
FillStrategies fFillStrategy
 
- Protected Attributes inherited from QModuleTimeProfiling
bool fTimeProfilingOn
 Report the time profiling. More...
 
unsigned long long int fProcessCalls
 NUmber of calls to the process. More...
 
double fProcessTime
 Total time spent running the process. More...
 

Detailed Description

Neighbours that are neighbours in time.

Author
M. Vignati

IsInWindow: If from the same start run time and event time is within a window specified by WindowSizeMs.

IsNeighbour: If from the same start run time and event time is within a window specified by WindowSizeMs.

Definition at line 20 of file QTimeNeighbour.hh.

Member Function Documentation

◆ GetNeighbourInfo()

QReaderNeighbour::NeighbourInfo QTimeNeighbour::GetNeighbourInfo ( const QEvent thisEvent,
const QEvent otherEvent 
)
virtual

◆ GetWantsNeighbours()

bool QTimeNeighbour::GetWantsNeighbours ( const QEvent thisEvent)
virtual

Reimplemented from QReaderNeighbour.

Definition at line 59 of file QTimeNeighbour.cc.

References fFiltVar, and QEvent::GetByLabel().

◆ Init()

Q_BEGIN_NAMESPACE void QTimeNeighbour::Init ( const QReader reader)
virtual

Initialzation.

Get the window size

Implements QReaderNeighbour.

Definition at line 9 of file QTimeNeighbour.cc.

References fFiltVar, fNeighbourDistanceMs, fNeighbourOffsetMs, fOffsetNs, fWindowSizeMs, QBaseModule::GetDouble(), and QBaseModule::GetString().

Referenced by QSameChannelNeighbour::Init().

Member Data Documentation

◆ fFiltVar

QEventLabel QTimeNeighbour::fFiltVar
private

Definition at line 39 of file QTimeNeighbour.hh.

Referenced by GetWantsNeighbours(), and Init().

◆ fNeighbourDistanceMs

double QTimeNeighbour::fNeighbourDistanceMs
private

Definition at line 36 of file QTimeNeighbour.hh.

Referenced by GetNeighbourInfo(), and Init().

◆ fNeighbourOffsetMs

double QTimeNeighbour::fNeighbourOffsetMs
private

Definition at line 37 of file QTimeNeighbour.hh.

Referenced by Init().

◆ fOffsetNs

long long QTimeNeighbour::fOffsetNs
private

Definition at line 38 of file QTimeNeighbour.hh.

Referenced by GetNeighbourInfo(), and Init().

◆ fWindowSizeMs

double QTimeNeighbour::fWindowSizeMs
private

Definition at line 35 of file QTimeNeighbour.hh.

Referenced by GetNeighbourInfo(), and Init().


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