precice::tooling Namespace Reference

Contains the preCICE tooling API. More...

Enumerations
enum struct	ConfigReferenceType { XML = 0 , DTD = 1 , MD = 2 }

Functions
void	printConfigReference (std::ostream &out, ConfigReferenceType reftype)
	Generates a configuration reference.
void	checkConfiguration (const std::string &filename, const std::string &participant, int size)
	Checks a given configuration.

Detailed Description

Contains the preCICE tooling API.

The contained methods allow to query internal information of preCICE without having to create a precice::Participant.

Note

These functions are not exposed via the bindings

See also

precice::getVersionInformation which is exposed via the bindings

Enumeration Type Documentation

ConfigReferenceType

enum struct precice::tooling::ConfigReferenceType

strong

The type of reference to generate

See also

precice::tooling::printConfigReference

Enumerator
XML	XML with inlined help.
DTD	DTD to check an XML.
MD	Markdown version used for the website.

Definition at line 23 of file Tooling.hpp.

Function Documentation

checkConfiguration()

PRECICE_API void precice::tooling::checkConfiguration	(	const std::string &	filename,
		const std::string &	participant,
		int	size )

Checks a given configuration.

Definition at line 32 of file Tooling.cpp.

Here is the call graph for this function:

printConfigReference()

PRECICE_API void precice::tooling::printConfigReference	(	std::ostream &	out,
		ConfigReferenceType	reftype )

Generates a configuration reference.

Parameters

[in,out]	out	The stream to write the result to.
[in]	reftype	The type of reference to generate.

See also

precice::tooling::ConfigReferenceType

Definition at line 15 of file Tooling.cpp.

Here is the call graph for this function: