libqalculate-1.0.0
Public Member Functions | Protected Member Functions | List of all members
DynamicVariable Class Referenceabstract

Abstract base class for variables with a value which is recalculated when the precision has changed. More...

#include <Variable.h>

Inheritance diagram for DynamicVariable:
KnownVariable Variable ExpressionItem

Public Member Functions

 DynamicVariable (string cat_, string name_, string title_="", bool is_local=false, bool is_builtin=true, bool is_active=true)
 
 DynamicVariable (const DynamicVariable *variable)
 
ExpressionItemcopy () const =0
 
void set (const ExpressionItem *item)
 
const MathStructureget ()
 
void set (const MathStructure &o)
 
void set (string expression_)
 
int calculatedPrecision () const
 
virtual bool representsPositive (bool=false)
 
virtual bool representsNegative (bool=false)
 
virtual bool representsNonNegative (bool=false)
 
virtual bool representsNonPositive (bool=false)
 
virtual bool representsInteger (bool=false)
 
virtual bool representsNumber (bool=false)
 
virtual bool representsRational (bool=false)
 
virtual bool representsReal (bool=false)
 
virtual bool representsComplex (bool=false)
 
virtual bool representsNonZero (bool=false)
 
virtual bool representsEven (bool=false)
 
virtual bool representsOdd (bool=false)
 
virtual bool representsUndefined (bool=false, bool=false, bool=false)
 
virtual bool representsBoolean ()
 
virtual bool representsNonMatrix ()
 
virtual bool representsScalar ()
 
- Public Member Functions inherited from KnownVariable
 KnownVariable (string cat_, string name_, const MathStructure &o, string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
 
 KnownVariable (string cat_, string name_, string expression_, string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
 
 KnownVariable ()
 
 KnownVariable (const KnownVariable *variable)
 
bool isKnown () const
 
virtual bool isExpression () const
 
virtual string expression () const
 
int subtype () const
 
- Public Member Functions inherited from Variable
 Variable (string cat_, string name_, string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
 
 Variable (const Variable *variable)
 
virtual int type () const
 
- Public Member Functions inherited from ExpressionItem
 ExpressionItem (string cat_, string name_, string title_="", string descr_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
 
virtual bool destroy ()
 
bool isRegistered () const
 
void setRegistered (bool is_registered)
 For internal use.
 
virtual const string & name (bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual const string & referenceName () const
 
virtual const ExpressionNamepreferredName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual const ExpressionNamepreferredInputName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual const ExpressionNamepreferredDisplayName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual const ExpressionNamegetName (size_t index) const
 
virtual void setName (const ExpressionName &ename, size_t index=1, bool force=true)
 
virtual void setName (string sname, size_t index, bool force=true)
 
virtual void addName (const ExpressionName &ename, size_t index=0, bool force=true)
 
virtual void addName (string sname, size_t index=0, bool force=true)
 
virtual size_t countNames () const
 
virtual void clearNames ()
 
virtual void clearNonReferenceNames ()
 
virtual void removeName (size_t index)
 
virtual size_t hasName (const string &sname, bool case_sensitive=true) const
 
virtual size_t hasNameCaseSensitive (const string &sname) const
 
virtual const ExpressionNamefindName (int abbreviation=-1, int use_unicode=-1, int plural=-1, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual const string & title (bool return_name_if_no_title=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual void setTitle (string title_)
 
virtual const string & description () const
 
virtual void setDescription (string descr_)
 
virtual const string & category () const
 
virtual void setCategory (string cat_)
 
virtual bool hasChanged () const
 
virtual void setChanged (bool has_changed)
 
virtual bool isLocal () const
 
virtual bool setLocal (bool is_local=true, int will_be_active=-1)
 
virtual bool isBuiltin () const
 
virtual bool isApproximate () const
 
virtual void setApproximate (bool is_approx=true)
 
virtual int precision () const
 
virtual void setPrecision (int prec)
 
virtual bool isActive () const
 
virtual void setActive (bool is_active)
 
virtual bool isHidden () const
 
virtual void setHidden (bool is_hidden)
 
virtual int refcount () const
 
virtual void ref ()
 
virtual void unref ()
 
virtual void ref (ExpressionItem *o)
 
virtual void unref (ExpressionItem *o)
 
virtual ExpressionItemgetReferencer (size_t index=1) const
 
virtual bool changeReference (ExpressionItem *o_from, ExpressionItem *o_to)
 

Protected Member Functions

virtual void calculate () const =0
 

Additional Inherited Members

- Protected Attributes inherited from KnownVariable
MathStructuremstruct
 
bool b_expression
 
int calculated_precision
 
string sexpression
 
- Protected Attributes inherited from ExpressionItem
string scat
 
string stitle
 
string sdescr
 
bool b_local
 
bool b_changed
 
bool b_builtin
 
bool b_approx
 
bool b_active
 
bool b_registered
 
bool b_hidden
 
bool b_destroyed
 
int i_ref
 
int i_precision
 
vector< ExpressionItem * > v_refs
 
vector< ExpressionNamenames
 

Detailed Description

Abstract base class for variables with a value which is recalculated when the precision has changed.

Member Function Documentation

◆ calculatedPrecision()

int DynamicVariable::calculatedPrecision ( ) const

Returns the precision of the calculated value.

Returns
Precision of the calculated value or zero if the value has not yet been calculated.

◆ get()

const MathStructure& DynamicVariable::get ( )
virtual

Returns the value of the variable. If no value is set or parsed and an expression is set, the expression is parsed and resulting value returned.

Returns
The value of the variable..

Reimplemented from KnownVariable.

◆ representsPositive()

virtual bool DynamicVariable::representsPositive ( bool  = false)
inlinevirtual

Returns if the variable represents a positive value.

Reimplemented from KnownVariable.

◆ set() [1/2]

void DynamicVariable::set ( const MathStructure o)
virtual

Sets the value of the variable. If expression is set, it is cleared.

Parameters
oValue.

Reimplemented from KnownVariable.

◆ set() [2/2]

void DynamicVariable::set ( string  expression_)
virtual

Sets the text string expression of the variable. The value is cleared.

Parameters
expression_Expression.

Reimplemented from KnownVariable.


The documentation for this class was generated from the following file: