Public Types | Public Member Functions | Static Public Member Functions | List of all members
empty_metric Class Reference

#include <base_metric.h>

Inheritance diagram for empty_metric:
base_metric summary_run_metric base_cycle_metric base_read_metric extended_tile_metric tile_metric corrected_intensity_metric error_metric extraction_metric image_metric phasing_metric q_collapsed_metric q_metric dynamic_phasing_metric index_metric

Public Types

typedef ::uint32_t id_t
 
typedef ::uint32_t uint_t
 
typedef constants::base_run_t base_t
 

Public Member Functions

template<class BaseMetric >
void set_base (const BaseMetric &)
 
void set_base (const uint_t, const uint_t)
 
bool operator< (const empty_metric &) const
 

Static Public Member Functions

static const char * suffix ()
 
static id_t create_id (const id_t, const id_t, const id_t=0)
 

Detailed Description

This is a sentinel used to ignore a metric in certain situations

See also
illumina::interop::logic::metric::table_entry::update

Member Typedef Documentation

typedef constants::base_run_t base_t

Define the base type

typedef ::uint32_t id_t

id_t type

typedef ::uint32_t uint_t

Unsigned int

Member Function Documentation

static id_t create_id ( const id_t  ,
const id_t  ,
const id_t  = 0 
)
inlinestatic

Unique id created from both the lane and tile

Returns
1
bool operator< ( const empty_metric &  ) const
inline

Comparison operator used to sort the entries in order of their IDs

Parameters
metric2metric to compare with the current object
Returns
true if this object's ID is less than metric2's ID
void set_base ( const BaseMetric &  )
inline

Set the base metric identifiers

Parameters
baselayout base
void set_base ( const uint_t  ,
const uint_t   
)
inline

Set id

Parameters
lanelane number
tiletile number
static const char* suffix ( )
inlinestatic

Get the metric name suffix

Returns
empty string
The documentation for this class was generated from the following file: