PyFmt.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Core/Export/PyFmt.h
//! @brief     Defines functions in namespace pyfmt.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_CORE_EXPORT_PYFMT_H
#define BORNAGAIN_CORE_EXPORT_PYFMT_H
 
#include "Base/Vector/Vectors3D.h"
#include <string>
 
//! Utility functions for writing Python code snippets.
 
namespace pyfmt {
 
std::string printImportedSymbols(const std::string& code);
 
std::string printInt(int value);
std::string printBool(double value);
std::string printDouble(double input);
std::string printLightDouble(double input);
std::string printNm(double input);
std::string printNm2(double input);
std::string printScientificDouble(double input);
std::string printDegrees(double input);
std::string printValue(double value, const std::string& units = "");
std::string printString(const std::string& value);
 
bool isSquare(double length1, double length2, double angle);
bool isHexagonal(double length1, double length2, double angle);
std::string printKvector(const kvector_t value);
 
//! Returns a string of blanks with given width. By default
//! the width equals standard offset in python files.
std::string indent(size_t width = 4u);
 
} // namespace pyfmt
 
#endif // BORNAGAIN_CORE_EXPORT_PYFMT_H
#endif // USER_API