application.h File Reference

#include "interop/model/run_metrics.h"

Go to the source code of this file.

Enumerations
enum	exit_codes {   SUCCESS, INVALID_ARGUMENTS, BAD_FORMAT, UNEXPECTED_EXCEPTION,   EMPTY_INTEROP, MISSING_RUNINFO_XML, MALFORMED_XML }

Functions
int	read_run_metrics (const char *filename, illumina::interop::model::metrics::run_metrics &metrics, const size_t thread_count, const bool check_empty=true)
int	read_run_metrics (const char *filename, illumina::interop::model::metrics::run_metrics &metrics, const std::vector< unsigned char > &valid_to_load, const size_t thread_count, const bool check_empty=true)

Detailed Description

Code shared among various applications

This is a private header file outside of any namespaces, beware!

Date

5/31/16

Version

1.0

Copyright

GNU Public License.

Enumeration Type Documentation

enum exit_codes

Exit codes that can be produced by the application

Enumerator
SUCCESS	The program exited cleanly, 0
INVALID_ARGUMENTS	Invalid arguments were given to the application
BAD_FORMAT	InterOp file has a bad format
UNEXPECTED_EXCEPTION	Unknown error has occurred
EMPTY_INTEROP	InterOp file has not records
MISSING_RUNINFO_XML	RunInfo is missing
MALFORMED_XML	XML is malformed

Function Documentation

int read_run_metrics ( const char *  filename, illumina::interop::model::metrics::run_metrics &  metrics, const size_t  thread_count, const bool  check_empty = true  )

inline

Read run metrics from the given filename

This function handles many error conditions.

Parameters

filename	run folder containing RunInfo.xml and InterOps
metrics	run metrics
thread_count	number of threads to use for network loading
check_empty	if true return an error if the metrics are empty

Returns

exit code

int read_run_metrics ( const char *  filename, illumina::interop::model::metrics::run_metrics &  metrics, const std::vector< unsigned char > &  valid_to_load, const size_t  thread_count, const bool  check_empty = true  )

inline

Read run metrics from the given filename

This function handles many error conditions.

Parameters

filename	run folder containing RunInfo.xml and InterOps
metrics	run metrics
valid_to_load	list of metrics that are valid to load
thread_count	number of threads to use for network loading
check_empty	if true return an error if the metrics are empty

Returns

exit code