API Documentation
Loading...
Searching...
No Matches
Formula.h
Go to the documentation of this file.
1#pragma once
2#include <NDEVR/Equation.h>
3#include <NDEVR/Unit.h>
4#include <NDEVR/Pointer.h>
5namespace NDEVR
6{
7 /**--------------------------------------------------------------------------------------------------
8 \brief Logic for storing the definition of a formula, that can be displayed to the end-user
9
10 **/
29
30 /**--------------------------------------------------------------------------------------------------
31 \brief Logic that saves formulas into a tree-like dependency structure
32
33 **/
40}
#define NDEVR_BASE_API
Definition DLLInfo.h:57
The equivelent of std::vector but with a bit more control. The basic array unit of the library.
Definition Buffer.hpp:56
Provides a constant, unmodifiable pointer that has shared ownership of a dynamically allocated object...
Definition GraphicsPipeline.h:42
A hash-based key-value store, useful for quick associative lookups. Key features include:
Definition Dictionary.h:61
Stores in a compressed way, a formula that can be solved. A formula is made of up variables,...
Definition Equation.h:45
Logic for reading or writing to a file as well as navigating filesystems.
Definition File.h:48
The core String class for the NDEVR API.
Definition String.h:69
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
Definition TranslatedString.h:13
Definition ACIColor.h:37
UnitCategory
A category of unit describing what it relates to. Any category can have some number of units defined ...
Definition Unit.h:14
double fltp08
Defines an alias representing an 8 byte floating-point number.
Definition BaseValues.hpp:149
Logic for storing the definition of a formula, that can be displayed to the end-user.
Definition Formula.h:12
String symbol
Definition Formula.h:14
Dictionary< String, String > dependent_variables
Definition Formula.h:20
static String DisplayString(const String &name)
ConstPointer< Unit > result_unit
Definition Formula.h:19
String category
Definition Formula.h:16
String simplifiedFormula() const
TranslatedString name
Definition Formula.h:13
String description
Definition Formula.h:15
Buffer< String > dependentVariables() const
String displayFormula(bool simplify) const
String formula
Definition Formula.h:17
fltp08 solve() const
Equation< fltp08 > equation() const
Logic that saves formulas into a tree-like dependency structure.
Definition Formula.h:35
void readFile(const File &formula_file)
Dictionary< String, Buffer< String > > top_level_formulas
Definition Formula.h:36
Dictionary< String, Dictionary< String, Buffer< Formula > > > formulas
Definition Formula.h:37