LibreVNA/Software/PC_Application/LibreVNA-GUI/Traces/Math/parser/mpValue.h
2022-10-01 17:10:44 +02:00

141 lines
5.3 KiB
C++

/** \file
\brief Definition of basic types used by muParserX
<pre>
__________ ____ ___
_____ __ _\______ \_____ _______ ______ __________\ \/ /
/ \| | \ ___/\__ \\_ __ \/ ___// __ \_ __ \ /
| Y Y \ | / | / __ \| | \/\___ \\ ___/| | \/ \
|__|_| /____/|____| (____ /__| /____ >\___ >__| /___/\ \
\/ \/ \/ \/ \_/
Copyright (C) 2016, Ingo Berg
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
</pre>
*/
#ifndef MUP_VALUE_H
#define MUP_VALUE_H
//--- Standard includes ------------------------------------------------------------
#include <complex>
#include <list>
//--- Parser framework -------------------------------------------------------------
#include "mpIValue.h"
#include "mpTypes.h"
MUP_NAMESPACE_START
//------------------------------------------------------------------------------
/** \brief Value class of muParserX
This class represents a value to be used with muParserX. It's a Variant like
class able to store a variety of types.
*/
class Value : public IValue
{
public:
explicit Value(char_type cType = 'v');
Value(int_type val);
Value(bool_type val);
Value(float_type val);
Value(string_type val);
Value(const char_type *val);
Value(const cmplx_type &v);
Value(const matrix_type &val);
// Array and Matrix constructors
Value(int_type m, float_type v);
Value(int_type m, int_type n, float_type v);
Value(const Value &a_Val );
Value(const IValue &a_Val);
Value& operator=(const Value &a_Val);
virtual ~Value();
virtual IValue& At(int nRow, int nCol = 0) override;
virtual IValue& At(const IValue &row, const IValue &col) override;
virtual IValue& operator=(int_type a_iVal) override;
virtual IValue& operator=(float_type a_fVal) override;
virtual IValue& operator=(string_type a_sVal) override;
virtual IValue& operator=(bool val) override;
virtual IValue& operator=(const matrix_type &a_vVal) override;
virtual IValue& operator=(const cmplx_type &val) override;
virtual IValue& operator=(const char_type *a_szVal);
virtual IValue& operator+=(const IValue &val) override;
virtual IValue& operator-=(const IValue &val) override;
virtual IValue& operator*=(const IValue &val) override;
virtual char_type GetType() const override;
virtual int_type GetInteger() const override;
virtual float_type GetFloat() const override;
virtual float_type GetImag() const override;
virtual bool GetBool() const override;
virtual const cmplx_type& GetComplex() const override;
virtual const string_type& GetString() const override;
virtual const matrix_type& GetArray() const override;
virtual int GetRows() const override;
virtual int GetCols() const override;
virtual bool IsVariable() const override;
virtual IToken* Clone() const override;
virtual Value* AsValue() override;
virtual string_type AsciiDump() const override;
void BindToCache(ValueCache *pCache);
// Conversion operators
operator cmplx_type();
operator int_type();
operator string_type();
operator float_type();
operator bool();
private:
cmplx_type m_val; ///< Member variable for storing the value of complex, float, int and boolean values
string_type *m_psVal; ///< Variable for storing a string value
matrix_type *m_pvVal; ///< A Vector for storing array variable content
char_type m_cType; ///< A byte indicating the type os the represented value
EFlags m_iFlags; ///< Additional flags
ValueCache *m_pCache; ///< Pointer to the Value Cache
void CheckType(char_type a_cType) const;
void Assign(const Value &a_Val);
void Reset();
virtual void Release() override;
}; // class Value
MUP_NAMESPACE_END
#endif