Files
create/src/Base/UnitsApi.h
luz.paz 011e5aedfa src/Base: [skip ci] fix header uniformity
This PR fixes header uniformity across all `src/Base` files
2019-12-25 11:38:58 +01:00

116 lines
4.5 KiB
C++

/***************************************************************************
* Copyright (c) 2009 Jürgen Riegel <FreeCAD@juergen-riegel.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef BASE_UNITSAPI_H
#define BASE_UNITSAPI_H
#include <CXX/WrapPython.h>
#include <memory>
#include <string>
#include <QString>
#include "UnitsSchema.h"
#include "Quantity.h"
namespace Base {
typedef std::unique_ptr<UnitsSchema> UnitsSchemaPtr;
/**
* The UnitsApi
*/
class BaseExport UnitsApi
{
public:
/** Constructs a UnitsApi object. */
UnitsApi(const char* filter);
UnitsApi(const std::string& filter);
virtual ~UnitsApi();
/** set Schema
* set the UnitsSchema of the Application
* this a represented by a class of type UnitSchema which
* defines a set of standard units for that schema and rules
* for representative strings.
*/
static void setSchema(UnitSystem s);
/// return the active schema
static UnitSystem getSchema(void){return actSystem;}
/// Returns a brief description of a schema
static const char* getDescription(UnitSystem);
static QString schemaTranslate(const Base::Quantity& quant, double &factor, QString &unitString);
static QString schemaTranslate(const Base::Quantity& quant) { // to satisfy GCC
double dummy1;
QString dummy2;
return UnitsApi::schemaTranslate(quant, dummy1, dummy2);
}
/// generate a value for a quantity with default user preferred system
static double toDbl(PyObject *ArgObj,const Base::Unit &u=Base::Unit());
/// generate a value for a quantity with default user preferred system
static Quantity toQuantity(PyObject *ArgObj,const Base::Unit &u=Base::Unit());
// set the number of decimals
static void setDecimals(int);
// fet the number of decimals
static int getDecimals();
/// set the application defaults
//static void setDefaults(void);
//@}
//double Result;
// Python interface
static PyMethodDef Methods[];
static double defaultFactor;
/// return an instance of the given enum value
static UnitsSchemaPtr createSchema(UnitSystem s);
protected:
// not used at the moment
static UnitsSchemaPtr UserPrefSystem;
static UnitSystem actSystem;
/// number of decimals for floats
static int UserPrefDecimals;
// do the real work
//static double parse(const char*,bool &UsedUnit);
protected: // the python API wrapper methods
//static PyObject *sTranslateUnit (PyObject *self,PyObject *args);
//static PyObject *sGetWithPrefs (PyObject *self,PyObject *args);
static PyObject *sParseQuantity (PyObject *self,PyObject *args);
static PyObject *sListSchemas (PyObject *self,PyObject *args);
static PyObject *sGetSchema (PyObject *self,PyObject *args);
static PyObject *sSetSchema (PyObject *self,PyObject *args);
static PyObject *sSchemaTranslate (PyObject *self,PyObject *args);
};
} // namespace Base
#endif // BASE_UNITSAPI_H