"Fossies" - the Fresh Open Source Software Archive

Member "libqalculate-3.6.0/docs/reference/html/classDataPropertyArgument.html" (23 Nov 2019, 32068 Bytes) of package /linux/privat/libqalculate-3.6.0.tar.gz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the libqalculate-3.6.0.tar.gz project site itself.

libqalculate-3.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DataPropertyArgument Class Reference

Data property function argument. More...

#include <DataSet.h>

Inheritance diagram for DataPropertyArgument:
Argument

Public Member Functions

 DataPropertyArgument (DataSet *data_set, std::string name_="", bool does_test=true, bool does_error=true)
 
 DataPropertyArgument (const DataPropertyArgument *arg)
 
int type () const
 
Argumentcopy () const
 
std::string print () const
 
DataSetdataSet () const
 
void setDataSet (DataSet *data_set)
 
- Public Member Functions inherited from Argument
 Argument (std::string name_="", bool does_test=true, bool does_error=true)
 
 Argument (const Argument *arg)
 
virtual ~Argument ()
 
virtual void set (const Argument *arg)
 
std::string printlong () const
 
bool test (MathStructure &value, int index, MathFunction *f, const EvaluationOptions &eo=default_evaluation_options) const
 
virtual MathStructure parse (const std::string &str, const ParseOptions &po=default_parse_options) const
 
virtual void parse (MathStructure *mstruct, const std::string &str, const ParseOptions &po=default_parse_options) const
 
std::string name () const
 
void setName (std::string name_)
 
void setCustomCondition (std::string condition)
 
std::string getCustomCondition () const
 
bool tests () const
 
void setTests (bool does_error)
 
bool alerts () const
 
void setAlerts (bool does_error)
 
bool zeroForbidden () const
 
void setZeroForbidden (bool forbid_zero)
 
bool matrixAllowed () const
 
void setMatrixAllowed (bool allow_matrix)
 
bool handlesVector () const
 
void setHandleVector (bool handle_vector)
 
bool isLastArgument () const
 
void setIsLastArgument (bool is_last)
 
bool rationalPolynomial () const
 
void setRationalPolynomial (bool rational_polynomial)
 
virtual bool suggestsQuotes () const
 

Protected Member Functions

virtual bool subtest (MathStructure &value, const EvaluationOptions &eo) const
 
virtual std::string subprintlong () const
 

Protected Attributes

DataSeto_data
 
- Protected Attributes inherited from Argument
std::string sname
 
std::string scondition
 
bool b_zero
 
bool b_test
 
bool b_matrix
 
bool b_text
 
bool b_error
 
bool b_rational
 
bool b_last
 
bool b_handle_vector
 

Detailed Description

Data property function argument.

Member Function Documentation

◆ copy()

Argument* DataPropertyArgument::copy ( ) const
virtual

Returns a copy of the argument definition.

Returns
A copy.

Reimplemented from Argument.

◆ print()

std::string DataPropertyArgument::print ( ) const
virtual

Resturns a short description of the argument definition. Ex. "number" for NumberArgument.

Returns
Short description.

Reimplemented from Argument.

◆ subprintlong()

virtual std::string DataPropertyArgument::subprintlong ( ) const
protectedvirtual

This function is called from Argument::printlong() and returns description specific the argument definition type. Should be reimplemented by all subclasses. For example IntegerArgument::subprintlong() might return "an integer" and Argument::printlong() might append " that fulfills the condition: even(\x)".

Returns
Long description.

Reimplemented from Argument.

◆ subtest()

virtual bool DataPropertyArgument::subtest ( MathStructure value,
const EvaluationOptions eo 
) const
protectedvirtual

This function is called from Argument::test() and performs validation specific to the argument definition type. Should be reimplemented by all subclasses.

Parameters
valueValue to test.
eoEvaluation options to use if the value needs to be evaluated.
Returns
true if the value is valid for the argument definition.

Reimplemented from Argument.

◆ type()

int DataPropertyArgument::type ( ) const
virtual

Returns the type of the argument, corresponding to which subclass the object belongs to.

Returns
ArgumentType.

Reimplemented from Argument.


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