ADTF
Static Public Member Functions | List of all members
DDFile

Convenience class to load and validate a Data Definition form a xml file string. More...

Static Public Member Functions

static dd::DataDefinition fromXMLFile (const std::string &xml_filepath, bool strict=false)
 Read a file containing a data definiton in XML. More...
 
static dd::DataDefinition fromXMLFile (const std::string &xml_filepath, dd::DataDefinition base_dd, bool strict=false)
 Read a file containing a data definiton in XML and merge it with an existing definition. More...
 
static void toXMLFile (const dd::DataDefinition &ddl_to_write, const std::string &xml_filepath)
 Writes DataDefinition to a file containing a data definiton in XML. More...
 
static void toXMLFile (const dd::DataDefinition &ddl_to_write, const std::string &xml_filepath, a_util::SortingOrder order)
 Writes sorted DataDefinition to a file containing a data definiton in XML. More...
 

Detailed Description

Convenience class to load and validate a Data Definition form a xml file string.


This implementation can be used as follows:

//read the whole file and provide the contained DDL
//if there are validation errors, see @ref ddl::dd::Error::problems
auto my_dd_1 = DDFile::fromXMLFile("<struct name=\"mystruct\" version=\"1\"></struct>");
ddl::DDFile::fromXMLFile
static dd::DataDefinition fromXMLFile(const std::string &xml_filepath, bool strict=false)
Read a file containing a data definiton in XML.
See also
DDString::fromXMLString, DDString::toXMLString

Definition at line 38 of file ddfile.h.

Member Function Documentation

◆ fromXMLFile() [1/2]

static dd::DataDefinition fromXMLFile ( const std::string &  xml_filepath,
bool  strict = false 
)
static

Read a file containing a data definiton in XML.

Parameters
xml_filepatha valid filesystem path for loading a DataDefinition xmlfile.
strictset to true to load the datamodel exactly like defined (no mixture of DDL tag definitions allowed).
Exceptions
ddl::dd::Errorif the xml file is not valid against the xsd definition (depending on the DDL Version).
ddl::dd::Errorif the validation level of the created DataDefinition is not at least good_enough!
Returns
dd::DataDefinition the valid Data Definiton of the file.

◆ fromXMLFile() [2/2]

static dd::DataDefinition fromXMLFile ( const std::string &  xml_filepath,
dd::DataDefinition  base_dd,
bool  strict = false 
)
static

Read a file containing a data definiton in XML and merge it with an existing definition.

Parameters
xml_filepatha valid filesystem path for loading a DataDefinition xmlfile.
base_ddvalid base ddl to merge the new parsed file with.
strictset to true to load the datamodel exactly like defined (no mixture of DDL tag definitions allowed).
Exceptions
ddl::dd::Errorif the xml file is not valid against the xsd definition (depending on the DDL Version).
ddl::dd::Errorif the validation level of the created DataDefinition is not at least good_enough!
ddl::dd::Errorif the given base_dd is not valid with at least validation level good_enough!
Returns
dd::DataDefinition the valid Data Definiton of the file.

◆ toXMLFile() [1/2]

static void toXMLFile ( const dd::DataDefinition &  ddl_to_write,
const std::string &  xml_filepath 
)
static

Writes DataDefinition to a file containing a data definiton in XML.

Parameters
xml_filepatha valid filesystem path for loading a DataDefinition xmlfile.
ddl_to_writea valid DataDefinition for writing a xmlfile.
Exceptions
ddl::dd::ErrorFile could not be written.

◆ toXMLFile() [2/2]

static void toXMLFile ( const dd::DataDefinition &  ddl_to_write,
const std::string &  xml_filepath,
a_util::SortingOrder  order 
)
static

Writes sorted DataDefinition to a file containing a data definiton in XML.

Parameters
xml_filepatha valid filesystem path for loading a DataDefinition xmlfile.
ddl_to_writea valid DataDefinition for writing a xmlfile.
Exceptions
ddl::dd::ErrorFile could not be written.
Parameters
[in]orderSort elements in description file in either ascending or descending order.