ddl::mapping::MappingFile Class Reference

Convenience class to load and validate a MappingConfiguration from a xml file string.
This implementation can be used as follows: More...

#include <mapping_file.h>

Static Public Member Functions
static mapping::MappingConfiguration	fromXMLFile (const std::string &xml_filepath)
	Read a file containing a MappingConfiguration in XML.
static void	toXMLFile (const mapping::MappingConfiguration &config_to_write, const std::string &xml_filepath)
	Writes MappingConfiguration to a file.
static void	toXMLFile (const mapping::MappingConfiguration &config_to_write, const std::string &xml_filepath, a_util::SortingOrder order)
	Writes sorted MappingConfiguration to a xml file.

Detailed Description

Convenience class to load and validate a MappingConfiguration from a xml file string.
This implementation can be used as follows:

//read the whole file and provide the contained MappingConfiguration
//if there are validation errors, see @ref ddl::mapping::Error::problems
auto my_config_1 = MappingFile::fromXMLFile("engine.mapping");

See also

MappingFile::fromXMLFile, MappingFile::toXMLFile

Member Function Documentation

fromXMLFile()

static mapping::MappingConfiguration ddl::mapping::MappingFile::fromXMLFile ( const std::string & xml_filepath )

static

Read a file containing a MappingConfiguration in XML.

Parameters

xml_filepath

a valid filesystem path for loading a MappingConfiguration xml file.

Exceptions

ddl::mapping::Error	if the xml file is not valid against the xsd definition (depending on the Mapping Version).
ddl::mapping::Error	if the validation level of the created MappingConfiguration is not at least ValidationLevel::good_enough!

Returns

mapping::MappingConfiguration the valid MappingConfiguration of the file.

toXMLFile() [1/2]

static void ddl::mapping::MappingFile::toXMLFile ( const mapping::MappingConfiguration & config_to_write, const std::string & xml_filepath )

static

Writes MappingConfiguration to a file.

Parameters

config_to_write	a valid MappingConfiguration for writing in a xml file.
xml_filepath	a valid filesystem path for writing a MappingConfiguration xml file.

Exceptions

ddl::mapping::Error

File could not be written, see details in exception.

toXMLFile() [2/2]

static void ddl::mapping::MappingFile::toXMLFile ( const mapping::MappingConfiguration & config_to_write, const std::string & xml_filepath, a_util::SortingOrder order )

static

Writes sorted MappingConfiguration to a xml file.

Parameters

config_to_write	a valid MappingConfiguration for writing in a xml file.
xml_filepath	a valid filesystem path for writing a MappingConfiguration xml file.

Exceptions

ddl::mapping::Error

File could not be written, see details in exception.

Parameters

[in]

order

Sort elements in description file in either ascending or descending order

---

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

• include/ddl/mapping/mapping_file.h