datatools::configuration::ascii_io Class Reference

ASCII I/O utility for variant repository and registries. More...

#include <bayeux/datatools/configuration/io.h>

Public Types
enum	store_flags {   IO_DESCRIPTION = datatools::bit_mask::bit00, IO_TITLE = datatools::bit_mask::bit01, IO_TRACE = datatools::bit_mask::bit02, IO_NO_HEADER = datatools::bit_mask::bit03,   IO_DONT_IGNORE_UNKNOWN_REGISTRY = datatools::bit_mask::bit04, IO_DEFAULT = 0 }
	Special initialization flags for the ASCII I/O utility. More...

Public Member Functions
	ascii_io (uint32_t flags_=IO_DEFAULT)
	Default constructor. More...
void	store_record (std::ostream &out_, const variant_record &vrec_) const
	Store a variant registry record. More...
int	load_record (std::istream &in_, variant_record &vrec_) const
	Load a variant registry record. More...
void	store_registry (std::ostream &out_, const variant_registry &vreg_) const
	Store a variant registry. More...
int	load_registry (std::istream &in_, variant_registry &vreg_) const
	Load a variant registry. More...
void	store_repository (std::ostream &out_, const variant_repository &vrep_) const
	Store a variant repository. More...
int	load_repository (std::istream &in_, variant_repository &vrep_) const
	Load a variant repository. More...
logger::priority	get_logging () const
	Return the logging priority. More...
void	set_logging (logger::priority)
	Set the logging priority. More...
void	print (std::ostream &out_, const std::string &title_="") const
	Print. More...

Static Public Member Functions
static const std::string &	unset_label ()
	Return unset parameter label. More...
static const std::string &	error_label ()
	Return error parameter label. More...
static const std::string &	format_label ()
	Return format label. More...
static version_id	current_format_version_id ()
	Return the current format version identifier. More...

Detailed Description

ASCII I/O utility for variant repository and registries.

Member Enumeration Documentation

store_flags

enum datatools::configuration::ascii_io::store_flags

Special initialization flags for the ASCII I/O utility.

Enumerator
IO_DESCRIPTION	Print meta comment.
IO_TITLE	Print title comment.
IO_TRACE	Trace/debug mode.
IO_NO_HEADER	Do not print header.
IO_DONT_IGNORE_UNKNOWN_REGISTRY	Do not load unknown registries from profile.
IO_DEFAULT	Default flags.

Constructor & Destructor Documentation

ascii_io()

datatools::configuration::ascii_io::ascii_io ( uint32_t  flags_ = IO_DEFAULT )

explicit

Default constructor.

Member Function Documentation

current_format_version_id()

static version_id datatools::configuration::ascii_io::current_format_version_id ( )

static

Return the current format version identifier.

error_label()

static const std::string& datatools::configuration::ascii_io::error_label ( )

static

Return error parameter label.

format_label()

static const std::string& datatools::configuration::ascii_io::format_label ( )

static

Return format label.

get_logging()

logger::priority datatools::configuration::ascii_io::get_logging

(

)

const

Return the logging priority.

load_record()

int datatools::configuration::ascii_io::load_record	(	std::istream &	in_,
		variant_record &	vrec_
	)		const

Load a variant registry record.

load_registry()

int datatools::configuration::ascii_io::load_registry	(	std::istream &	in_,
		variant_registry &	vreg_
	)		const

Load a variant registry.

load_repository()

int datatools::configuration::ascii_io::load_repository	(	std::istream &	in_,
		variant_repository &	vrep_
	)		const

Load a variant repository.

print()

void datatools::configuration::ascii_io::print	(	std::ostream &	out_,
		const std::string &	title_ = ""
	)		const

Print.

set_logging()

void datatools::configuration::ascii_io::set_logging

(

logger::priority

)

Set the logging priority.

store_record()

void datatools::configuration::ascii_io::store_record	(	std::ostream &	out_,
		const variant_record &	vrec_
	)		const

Store a variant registry record.

store_registry()

void datatools::configuration::ascii_io::store_registry	(	std::ostream &	out_,
		const variant_registry &	vreg_
	)		const

Store a variant registry.

store_repository()

void datatools::configuration::ascii_io::store_repository	(	std::ostream &	out_,
		const variant_repository &	vrep_
	)		const

Store a variant repository.

unset_label()

static const std::string& datatools::configuration::ascii_io::unset_label ( )

static

Return unset parameter label.

---

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

• bayeux/datatools/configuration/io.h