abstract_text_format< Metric > Struct Template Referenceabstract
#include <abstract_text_format.h>
Inheritance diagram for abstract_text_format< Metric >:
Public Types | |
| typedef Metric | metric_t |
| typedef Metric::header_type | header_t |
| typedef metric_t::id_t | id_t |
Public Member Functions | |
| virtual | ~abstract_text_format () |
| virtual size_t | write_header (std::ostream &out, const header_t &header, const std::vector< std::string > &channel_names, const char sep, const char eol)=0 |
| virtual size_t | write_metric (std::ostream &out, const metric_t &metric, const header_t &header, const char sep, const char eol, const char missing)=0 |
| virtual ::int16_t | version () const =0 |
Detailed Description
template<class Metric>
struct illumina::interop::io::abstract_text_format< Metric >
Abstract class that provides an interface for the text format of a metric
The template argument for this class corresponds to a specific type of metric set.
Member Typedef Documentation
| typedef Metric::header_type header_t |
Define the metric header type
| typedef metric_t::id_t id_t |
ID type
| typedef Metric metric_t |
Define the metric type
Constructor & Destructor Documentation
|
inlinevirtual |
Destructor
Member Function Documentation
|
pure virtual |
Get the version of this metric format
- Returns
- version number
Implemented in text_format< Metric, text_layout< Metric, Version > >.
|
pure virtual |
Write the header for a set of metric records to the given output stream
- Parameters
-
out output stream to write the binary InterOp file data header header of a metric set channel_names list of channel names sep column seperator eol row separator
- Returns
- number of column headers
Implemented in text_format< Metric, text_layout< Metric, Version > >.
|
pure virtual |
Write a metric record to the given output stream
- Parameters
-
out output stream to write the binary InterOp file data metric interop metric data to write header interop metric header data to write sep column seperator eol row separator missing missing value indicator
- Returns
- number of columns written
Implemented in text_format< Metric, text_layout< Metric, Version > >.
The documentation for this struct was generated from the following file:
- /io/interop/io/format/abstract_text_format.h