Utility class to build VariantHeader objects from scratch. More...

Public Member Functions
	VariantHeaderBuilder () noexcept
	initializes a variant header builder More...

	VariantHeaderBuilder (VariantHeaderBuilder &&other) noexcept

	VariantHeaderBuilder (const VariantHeaderBuilder &other)=delete
	explicitly forbid copying of a builder More...

void	add_contig (const std::string &id, const std::string &length="", const std::string &url="", const std::string &extra="")

void	add_filter (const std::string &id, const std::string &description="", const std::string &extra="")

void	add_info_field (const std::string &id, const std::string &number, const std::string &type, const std::string &description="", const std::string &source="", const std::string &version="", const std::string &extra="")

void	add_format_field (const std::string &id, const std::string &number, const std::string &type, const std::string &description="", const std::string &extra="")

void	add_sample (const std::string &sample)

void	add_source (const std::string &source)

void	advanced_add_arbitrary_line (const std::string &line)

VariantHeader	build () const

Detailed Description

Utility class to build VariantHeader objects from scratch.

Constructor & Destructor Documentation

gamgee::VariantHeaderBuilder::VariantHeaderBuilder ( )

noexcept

initializes a variant header builder

Note: VariantReader and VariantWriter will take care of creating objects for reading and writing respectively if your goal is to write a VCF/BCF file to disk or stream.

Warning: you should only call this explicitly if you are building a VariantHeader from scratch.

gamgee::VariantHeaderBuilder::VariantHeaderBuilder ( VariantHeaderBuilder && other )

noexcept

gamgee::VariantHeaderBuilder::VariantHeaderBuilder ( const VariantHeaderBuilder & other )

delete

explicitly forbid copying of a builder

void gamgee::VariantHeaderBuilder::add_contig	(	const std::string &	id,
		const std::string &	length = `""`,
		const std::string &	url = `""`,
		const std::string &	extra = `""`
	)

void gamgee::VariantHeaderBuilder::add_filter	(	const std::string &	id,
		const std::string &	description = `""`,
		const std::string &	extra = `""`
	)

void gamgee::VariantHeaderBuilder::add_format_field	(	const std::string &	id,
		const std::string &	number,
		const std::string &	type,
		const std::string &	description = `""`,
		const std::string &	extra = `""`
	)

void gamgee::VariantHeaderBuilder::add_info_field	(	const std::string &	id,
		const std::string &	number,
		const std::string &	type,
		const std::string &	description = `""`,
		const std::string &	source = `""`,
		const std::string &	version = `""`,
		const std::string &	extra = `""`
	)

void gamgee::VariantHeaderBuilder::add_sample ( const std::string & sample )

void gamgee::VariantHeaderBuilder::add_source ( const std::string & source )

void gamgee::VariantHeaderBuilder::advanced_add_arbitrary_line ( const std::string & line )

VariantHeader gamgee::VariantHeaderBuilder::build ( ) const

inline

The documentation for this class was generated from the following files: