enums.h

Go to the documentation of this file.

#pragma once

#include <climits>
#include <limits>
#include <string>
#include "interop/util/cstdint.h"

#define INTEROP_UNKNOWN 0x800


#define INTEROP_ENUM_METRIC_FEATURE_TYPE \
        INTEROP_TUPLE_ASSIGN(TileFeature, 0x01), \
        INTEROP_TUPLE_ASSIGN(CycleFeature, 0x02), \
        INTEROP_TUPLE_ASSIGN(ReadFeature, 0x04), \
        INTEROP_TUPLE_ASSIGN(BaseFeature, 0x08), \
        INTEROP_TUPLE_ASSIGN(ChannelFeature, 0x10), \
        INTEROP_TUPLE_ASSIGN(LaneFeature, 0x20), \
        INTEROP_TUPLE_ASSIGN(DiskFeature, 0x400), \
        INTEROP_TUPLE1(UnknownMetricFeature)
//NOTE: if we add any more features above, we should update the unknown metric value below

#define INTEROP_ENUM_METRIC_TYPES \
        INTEROP_TUPLE7(Intensity, "Intensity", Extraction, CycleFeature|ChannelFeature, extraction_metric, max_intensity, channel)\
        INTEROP_TUPLE7(FWHM, "FWHM", Extraction, CycleFeature|ChannelFeature, extraction_metric, focus_score, channel)\
        INTEROP_TUPLE7(BasePercent, "% Base", CorrectedInt, CycleFeature|BaseFeature, corrected_intensity_metric, percent_base, base)\
        INTEROP_TUPLE7(PercentNoCall, "% NoCall", CorrectedInt, CycleFeature, corrected_intensity_metric, percent_nocall, Void)\
        INTEROP_TUPLE7(Q20Percent, "% >=Q20", Q, CycleFeature, q_collapsed_metric, percent_over_q20, Void)\
        INTEROP_TUPLE7(Q30Percent, "% >=Q30", Q, CycleFeature, q_collapsed_metric, percent_over_q30, Void)\
        INTEROP_TUPLE7(AccumPercentQ20, "% >=Q20 (Accumulated)", Q, CycleFeature, q_collapsed_metric, cumulative_percent_over_q20, Void)\
        INTEROP_TUPLE7(AccumPercentQ30, "% >=Q30 (Accumulated)", Q, CycleFeature, q_collapsed_metric, cumulative_percent_over_q30, Void)\
        INTEROP_TUPLE7(QScore, "Median QScore", Q, CycleFeature, q_collapsed_metric, median_qscore_flt, Void)\
        INTEROP_TUPLE7(Clusters, "Density", Tile, TileFeature, tile_metric, cluster_density_k, Void)\
        INTEROP_TUPLE7(ClustersPF, "Density PF", Tile, TileFeature, tile_metric, cluster_density_pf_k, Void)\
        INTEROP_TUPLE7(ClusterCount, "Cluster Count", Tile, TileFeature, tile_metric, cluster_count_m, Void)\
        INTEROP_TUPLE7(ClusterCountPF, "Clusters PF", Tile, TileFeature, tile_metric, cluster_count_pf_m, Void)\
        INTEROP_TUPLE7(ErrorRate, "Error Rate", Error, CycleFeature, error_metric, error_rate, Void)\
        INTEROP_TUPLE7(PercentPhasing, "Legacy Phasing Rate", Tile, ReadFeature, tile_metric, percent_phasing_at, read)\
        INTEROP_TUPLE7(PercentPrephasing, "Legacy Prephasing Rate", Tile, ReadFeature, tile_metric, percent_prephasing_at, read)\
        INTEROP_TUPLE7(PercentAligned, "% Aligned", Tile, ReadFeature, tile_metric, percent_aligned_at, read)\
        INTEROP_TUPLE7(Phasing, "Phasing Weight", EmpiricalPhasing, CycleFeature, phasing_metric, phasing_weight, Void)\
        INTEROP_TUPLE7(PrePhasing, "Prephasing Weight", EmpiricalPhasing, CycleFeature, phasing_metric, prephasing_weight, Void)\
        INTEROP_TUPLE7(CorrectedIntensity, "Corrected Int", CorrectedInt, CycleFeature|BaseFeature, corrected_intensity_metric, corrected_int_all_float, base)\
        INTEROP_TUPLE7(CalledIntensity, "Called Int", CorrectedInt, CycleFeature|BaseFeature, corrected_intensity_metric, corrected_int_called, base)\
        INTEROP_TUPLE7(SignalToNoise, "Signal to Noise", CorrectedInt, CycleFeature, corrected_intensity_metric, signal_to_noise, Void)\
        INTEROP_TUPLE7(OccupiedCountK, "Occupied Count (K)", ExtendedTile, TileFeature, extended_tile_metric, cluster_count_occupied_k, Void)\
        INTEROP_TUPLE7(PercentOccupied, "% Occupied", ExtendedTile, TileFeature, extended_tile_metric, percent_occupied, Void)\
        INTEROP_TUPLE7(PercentPF, "% PF", Tile, TileFeature, tile_metric, percent_pf, Void)\
        INTEROP_TUPLE4(MetricTypeCount, "!!!!BAD!!!!", UnknownMetricGroup, UnknownMetricFeature)\
        INTEROP_TUPLE1(UnknownMetricType)

#define INTEROP_ENUM_METRIC_GROUPS \
        INTEROP_TUPLE2(CorrectedInt, CycleFeature|BaseFeature|DiskFeature), \
        INTEROP_TUPLE2(Error, CycleFeature|DiskFeature), \
        INTEROP_TUPLE2(Extraction, CycleFeature|ChannelFeature|DiskFeature), \
        INTEROP_TUPLE2(Image, CycleFeature|ChannelFeature|DiskFeature), \
        INTEROP_TUPLE2(Index, ReadFeature|DiskFeature), \
        INTEROP_TUPLE2(Q, CycleFeature|DiskFeature), \
        INTEROP_TUPLE2(Tile, TileFeature|DiskFeature), \
        INTEROP_TUPLE2(QByLane, LaneFeature), \
        INTEROP_TUPLE2(QCollapsed, CycleFeature), \
        INTEROP_TUPLE2(EmpiricalPhasing, CycleFeature|DiskFeature), \
        INTEROP_TUPLE2(DynamicPhasing, CycleFeature), \
        INTEROP_TUPLE2(ExtendedTile, TileFeature|DiskFeature), \
        INTEROP_TUPLE2(SummaryRun, DiskFeature), \
        INTEROP_TUPLE1(MetricCount),\
        INTEROP_TUPLE1(UnknownMetricGroup)


#define INTEROP_ENUM_METRIC_DATA_TYPES \
        INTEROP_TUPLE1(IdType),\
        INTEROP_TUPLE1(ValueType),\
        INTEROP_TUPLE1(StructType),\
        INTEROP_TUPLE1(ChannelArray),\
        INTEROP_TUPLE1(BaseArray),\
        INTEROP_TUPLE1(MetricDataCount),\
        INTEROP_TUPLE1(UnknownMetricData)

#define INTEROP_ENUM_TILE_NAMING_METHODS \
\
        INTEROP_TUPLE1(FourDigit), \
\
        INTEROP_TUPLE1(FiveDigit), \
\
        INTEROP_TUPLE1(Absolute), \
\
        INTEROP_TUPLE1(TileNamingMethodCount), \
        INTEROP_TUPLE1(UnknownTileNamingMethod)

#define INTEROP_ENUM_DNA_BASE_TYPES \
 \
        INTEROP_TUPLE_ASSIGN(NC, -1), \
 \
        INTEROP_TUPLE1(A), \
 \
        INTEROP_TUPLE1(C), \
 \
        INTEROP_TUPLE1(G), \
 \
        INTEROP_TUPLE1(T), \
 \
        INTEROP_TUPLE1(NUM_OF_BASES), \
 \
        INTEROP_TUPLE1(NUM_OF_BASES_AND_NC), \
 \
        INTEROP_TUPLE1(UnknownBase)

#define INTEROP_ENUM_SURFACE_TYPES \
        INTEROP_TUPLE1(SentinelSurface), \
        INTEROP_TUPLE1(Top), \
        INTEROP_TUPLE1(Bottom), \
        INTEROP_TUPLE1(UnknownSurface)


#define INTEROP_ENUM_INSTRUMENT_TYPES \
        INTEROP_TUPLE1(HiSeq), \
        INTEROP_TUPLE1(HiScan), \
        INTEROP_TUPLE1(MiSeq), \
        INTEROP_TUPLE1(NextSeq), \
        INTEROP_TUPLE1(MiniSeq), \
        INTEROP_TUPLE1(NovaSeq), \
        INTEROP_TUPLE1(iSeq), \
        INTEROP_TUPLE1(NextSeq1k2k), \
        INTEROP_TUPLE1(InstrumentCount), \
        INTEROP_TUPLE1(UnknownInstrument)

#define INTEROP_ENUM_METRIC_BASE_TYPES \
\
        INTEROP_TUPLE1(BaseTileType),\
\
        INTEROP_TUPLE1(BaseCycleType),\
\
        INTEROP_TUPLE1(BaseReadType),\
\
        INTEROP_TUPLE1(BaseLaneType),\
\
        INTEROP_TUPLE1(BaseRunType), \
        INTEROP_TUPLE1(BaseMetricCount),\
        INTEROP_TUPLE1(UnknownBaseType)


#define INTEROP_ENUM_PLOT_COLORS \
\
        INTEROP_TUPLE1(Red), /*#FF0000*/\
\
        INTEROP_TUPLE1(Green), /*#00FF00*/\
\
        INTEROP_TUPLE1(Blue), /*#0000FF*/\
\
        INTEROP_TUPLE1(Black), /*#000000*/\
        INTEROP_TUPLE1(PlotColorCount), \
        INTEROP_TUPLE1(UnknownColor)

#define INTEROP_ENUM_PLOT_TYPES \
\
        INTEROP_TUPLE1(FlowcellPlot),\
\
        INTEROP_TUPLE1(ByCyclePlot),\
\
        INTEROP_TUPLE1(ByLanePlot),\
\
        INTEROP_TUPLE1(QHistogramPlot),\
\
        INTEROP_TUPLE1(QHeatmapPlot),\
\
        INTEROP_TUPLE1(SampleQCPlot),\
\
        INTEROP_TUPLE1(UnknownPlotType)

#define INTEROP_ENUM_BAR_PLOT_OPTIONS \
\
        INTEROP_TUPLE1(Centered), \
\
        INTEROP_TUPLE1(Shifted), \
        INTEROP_TUPLE1(UnknownBarPlotOption)

// Define x-macros


#define INTEROP_TUPLE7(X, Unused1, Unused2, Unused3, Unused4, Unused5, Unused6) X,

#define INTEROP_TUPLE4(X, Y, Z, A) X,

#define INTEROP_TUPLE3(X, Y, Z) X

#define INTEROP_TUPLE1(X) X

#define INTEROP_TUPLE2(X, V) X

#define INTEROP_TUPLE_ASSIGN(X, V) X=V



namespace illumina { namespace interop { namespace constants
{

    enum common
    {
        Unknown = INTEROP_UNKNOWN
    };
    enum metric_type
    {
        INTEROP_ENUM_METRIC_TYPES = INTEROP_UNKNOWN
    };
    enum metric_group
    {
        INTEROP_ENUM_METRIC_GROUPS = INTEROP_UNKNOWN
    };
    enum tile_naming_method
    {
        INTEROP_ENUM_TILE_NAMING_METHODS = INTEROP_UNKNOWN
    };
    enum dna_bases
    {
        INTEROP_ENUM_DNA_BASE_TYPES = INTEROP_UNKNOWN
    };
    enum surface_type
    {
        INTEROP_ENUM_SURFACE_TYPES = INTEROP_UNKNOWN
    };
    enum instrument_type
    {
        INTEROP_ENUM_INSTRUMENT_TYPES = INTEROP_UNKNOWN
    };
    enum metric_base_type
    {
        INTEROP_ENUM_METRIC_BASE_TYPES = INTEROP_UNKNOWN
    };
    enum plot_colors
    {
        INTEROP_ENUM_PLOT_COLORS = INTEROP_UNKNOWN
    };
    enum bar_plot_options
    {
        INTEROP_ENUM_BAR_PLOT_OPTIONS = INTEROP_UNKNOWN
    };
    enum metric_data
    {
        INTEROP_ENUM_METRIC_DATA_TYPES = INTEROP_UNKNOWN
    };
    enum metric_feature_type
    {
        INTEROP_ENUM_METRIC_FEATURE_TYPE = INTEROP_UNKNOWN
    };
    enum plot_types
    {
        INTEROP_ENUM_PLOT_TYPES = INTEROP_UNKNOWN
    };
}}}

#undef INTEROP_TUPLE1
#undef INTEROP_TUPLE2
#undef INTEROP_TUPLE3
#undef INTEROP_TUPLE4
#undef INTEROP_TUPLE7
#undef INTEROP_TUPLE_ASSIGN