text_format< Metric, text_layout< Metric, Version > > Struct Template Reference
#include <text_format.h>
Inheritance diagram for text_format< Metric, text_layout< Metric, Version > >:
Public Types | |
| typedef Metric | metric_t |
| typedef Metric::header_type | header_t |
 Public Types inherited from abstract_text_format< Metric > | |
| typedef Metric | metric_t |
| typedef Metric::header_type | header_t |
| typedef metric_t::id_t | id_t |
Public Member Functions | |
| size_t | write_header (std::ostream &out, const header_t &header, const std::vector< std::string > &channel_names, const char sep, const char eol) |
| size_t | write_metric (std::ostream &out, const metric_t &metric, const header_t &header, const char sep, const char eol, const char missing) |
| ::int16_t | version () const |
| Public Member Functions inherited from abstract_text_format< Metric > | |
| virtual | ~abstract_text_format () |
Detailed Description
template<class Metric, int Version>
struct illumina::interop::io::text_format< Metric, text_layout< Metric, Version > >
Shared functionality for writing text InterOp metrics
Specialization for text_layout
Member Typedef Documentation
| typedef Metric::header_type header_t |
Define the metric header type
| typedef Metric metric_t |
Define the metric type
Member Function Documentation
|
inlinevirtual |
Get the version of this metric format
- Returns
- version number
Implements abstract_text_format< Metric >.
|
inlinevirtual |
Write the header of text format 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
Implements abstract_text_format< Metric >.
|
inlinevirtual |
Write a text record to the given output stream
- Parameters
-
out output stream metric a metric to write header metric set header sep column seperator eol row separator missing missing value indicator
- Returns
- number of columns written
Implements abstract_text_format< Metric >.
The documentation for this struct was generated from the following file:
- /io/interop/io/format/text_format.h