preCICE v3.1.1
Loading...
Searching...
No Matches
Tooling.hpp
Go to the documentation of this file.
1#pragma once
2
3#include <iosfwd>
4#include <precice/export.h>
5#include <string>
6
7namespace precice {
8
18namespace tooling {
19
23enum struct ConfigReferenceType {
25 XML = 0,
27 DTD = 1,
29 MD = 2
30};
31
39PRECICE_API void printConfigReference(std::ostream &out, ConfigReferenceType reftype);
40
42PRECICE_API void checkConfiguration(const std::string &filename, const std::string &participant, int size);
43
44} // namespace tooling
45
55PRECICE_API std::string getVersionInformation();
56
57} // namespace precice
out
std::ostream & out
Definition EventUtils.cpp:193
precice::tooling::printConfigReference
void printConfigReference(std::ostream &out, ConfigReferenceType reftype)
Generates a configuration reference.
Definition Tooling.cpp:15
precice::tooling::checkConfiguration
void checkConfiguration(const std::string &filename, const std::string &participant, int size)
Checks a given configuration.
Definition Tooling.cpp:32
precice::tooling::ConfigReferenceType::MD
@ MD
Markdown version used for the website.
precice
Main namespace of the precice library.
Definition Acceleration.cpp:5
precice::getVersionInformation
std::string getVersionInformation()
Returns information on the version of preCICE.
Definition Tooling.cpp:70