UFO
ufo::ProfileCheckBase Class Referenceabstract

Profile QC checker base class. More...

#include <ProfileCheckBase.h>

Inheritance diagram for ufo::ProfileCheckBase:
Collaboration diagram for ufo::ProfileCheckBase:

Public Member Functions

 ProfileCheckBase (const ProfileConsistencyCheckParameters &options, const ProfileIndices &profileIndices, ProfileDataHandler &profileDataHandler, ProfileCheckValidator &profileCheckValidator)
 
virtual ~ProfileCheckBase ()
 
virtual void runCheck ()=0
 Run check. More...
 
virtual void fillValidator ()=0
 Fill variables in validator. More...
 
virtual bool getResult ()
 Get result of check (default fail) More...
 

Protected Member Functions

template<typename T >
void correctVector (const std::vector< T > &v1, const std::vector< T > &v2, std::vector< T > &vout)
 Apply correction to vector of values. More...
 

Protected Attributes

const ProfileConsistencyCheckParametersoptions_
 Configurable parameters. More...
 
const ProfileIndicesprofileIndices_
 Indices of profile's observations in the entire sample. More...
 
ProfileDataHandlerprofileDataHandler_
 Profile data handler. More...
 
ProfileCheckValidatorprofileCheckValidator_
 Profile check validator. More...
 
const float missingValueFloat = util::missingValue(1.0f)
 Missing value (float) More...
 

Detailed Description

Profile QC checker base class.

Definition at line 40 of file ProfileCheckBase.h.

Constructor & Destructor Documentation

◆ ProfileCheckBase()

ufo::ProfileCheckBase::ProfileCheckBase ( const ProfileConsistencyCheckParameters options,
const ProfileIndices profileIndices,
ProfileDataHandler profileDataHandler,
ProfileCheckValidator profileCheckValidator 
)

Definition at line 16 of file ProfileCheckBase.cc.

◆ ~ProfileCheckBase()

virtual ufo::ProfileCheckBase::~ProfileCheckBase ( )
inlinevirtual

Definition at line 46 of file ProfileCheckBase.h.

Member Function Documentation

◆ correctVector()

template<typename T >
void ufo::ProfileCheckBase::correctVector ( const std::vector< T > &  v1,
const std::vector< T > &  v2,
std::vector< T > &  vout 
)
inlineprotected

Apply correction to vector of values.

Definition at line 60 of file ProfileCheckBase.h.

Here is the caller graph for this function:

◆ fillValidator()

◆ getResult()

virtual bool ufo::ProfileCheckBase::getResult ( )
inlinevirtual

Get result of check (default fail)

Reimplemented in ufo::ProfileCheckBasic.

Definition at line 55 of file ProfileCheckBase.h.

◆ runCheck()

Member Data Documentation

◆ missingValueFloat

const float ufo::ProfileCheckBase::missingValueFloat = util::missingValue(1.0f)
protected

Missing value (float)

Definition at line 83 of file ProfileCheckBase.h.

◆ options_

const ProfileConsistencyCheckParameters& ufo::ProfileCheckBase::options_
protected

Configurable parameters.

Definition at line 71 of file ProfileCheckBase.h.

◆ profileCheckValidator_

ProfileCheckValidator& ufo::ProfileCheckBase::profileCheckValidator_
protected

Profile check validator.

Definition at line 80 of file ProfileCheckBase.h.

◆ profileDataHandler_

ProfileDataHandler& ufo::ProfileCheckBase::profileDataHandler_
protected

Profile data handler.

Definition at line 77 of file ProfileCheckBase.h.

◆ profileIndices_

const ProfileIndices& ufo::ProfileCheckBase::profileIndices_
protected

Indices of profile's observations in the entire sample.

Definition at line 74 of file ProfileCheckBase.h.


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