FormulaToken Class Reference

#include <EnhancedPathFormula.h>

Public Types
enum	Operator {   OperatorInvalid , OperatorAdd , OperatorSub , OperatorMul ,   OperatorDiv , OperatorLeftPar , OperatorRightPar , OperatorComma }
	operator types More...
enum	Type {   TypeUnknown = 0 , TypeNumber , TypeOperator , TypeReference ,   TypeFunction }
	token types More...

Public Member Functions
qreal	asNumber () const
	Returns the token converted to qreal.
Operator	asOperator () const
	Returns the token as operator.
	FormulaToken (const FormulaToken &token)
	copy constructor
	FormulaToken (Type type=TypeUnknown, const QString &text=QString(), int position=-1)
	Constructs token with given type, text and position.
bool	isFunction () const
	Returns if token is a function.
bool	isNumber () const
	Returns if the token is a number.
bool	isOperator () const
	Returns if the token is a operator, OperatorInvalid if token is no operator.
bool	isReference () const
	Returns if token is a reference.
FormulaToken &	operator= (const FormulaToken &token)
	assignment operator
int	position () const
	Returns the position of the token.
QString	text () const
	Returns the text representation of the token.
Type	type () const
	Returns the type of the token.

Private Attributes
int	m_position {-1}
	the tokens position
QString	m_text
	the token text representation
Type	m_type {TypeUnknown}
	the token type

Detailed Description

Definition at line 15 of file EnhancedPathFormula.h.

Member Enumeration Documentation

Operator

enum FormulaToken::Operator

operator types

Enumerator
OperatorInvalid	invalid operator
OperatorAdd	addition
OperatorSub	subtraction
OperatorMul	multiplication
OperatorDiv	/ division
OperatorLeftPar	(left parentheses
OperatorRightPar	) right parentheses
OperatorComma	, comma

Definition at line 28 of file EnhancedPathFormula.h.

                  {
        OperatorInvalid,   
        OperatorAdd,       
        OperatorSub,       
        OperatorMul,       
        OperatorDiv,       
        OperatorLeftPar,   
        OperatorRightPar,  
        OperatorComma      
    };

Type

enum FormulaToken::Type

token types

Enumerator
TypeUnknown	unknown type
TypeNumber	14, 3, 1977, 3.141592, 1e10, 5.9e-7
TypeOperator	+, *, /, -
TypeReference	function reference, modifier reference or named variable
TypeFunction	function name

Definition at line 19 of file EnhancedPathFormula.h.

              {
        TypeUnknown = 0, 
        TypeNumber,      
        TypeOperator,    
        TypeReference,   
        TypeFunction     
    };

Constructor & Destructor Documentation

FormulaToken() [1/2]

FormulaToken::FormulaToken ( Type type = TypeUnknown, const QString & text = QString(), int position = -1 )

explicit

Constructs token with given type, text and position.

Definition at line 654 of file EnhancedPathFormula.cpp.

    : m_type(type), m_text(text), m_position(position)
{
}

FormulaToken() [2/2]

FormulaToken::FormulaToken

(

const FormulaToken &

token

)

copy constructor

Definition at line 659 of file EnhancedPathFormula.cpp.

{
    if (this != &token) {
        *this = token;
    }
}

Member Function Documentation

asNumber()

qreal FormulaToken::asNumber

(

)

const

Returns the token converted to qreal.

Definition at line 679 of file EnhancedPathFormula.cpp.

{
    if (isNumber()) {
        return m_text.toDouble();
    } else {
        return 0.0;
    }
}

References isNumber(), and m_text.

asOperator()

FormulaToken::Operator FormulaToken::asOperator

(

)

const

Returns the token as operator.

Definition at line 688 of file EnhancedPathFormula.cpp.

{
    if (isOperator()) {
        return matchOperator(m_text);
    } else {
        return OperatorInvalid;
    }
}

References isOperator(), m_text, matchOperator(), and OperatorInvalid.

isFunction()

bool FormulaToken::isFunction ( ) const

inline

Returns if token is a function.

Definition at line 75 of file EnhancedPathFormula.h.

    {
        return m_type == TypeFunction;
    }

References m_type, and TypeFunction.

isNumber()

bool FormulaToken::isNumber ( ) const

inline

Returns if the token is a number.

Definition at line 65 of file EnhancedPathFormula.h.

    {
        return m_type == TypeNumber;
    }

References m_type, and TypeNumber.

isOperator()

bool FormulaToken::isOperator ( ) const

inline

Returns if the token is a operator, OperatorInvalid if token is no operator.

Definition at line 70 of file EnhancedPathFormula.h.

    {
        return m_type == TypeOperator;
    }

References m_type, and TypeOperator.

isReference()

bool FormulaToken::isReference ( ) const

inline

Returns if token is a reference.

Definition at line 80 of file EnhancedPathFormula.h.

    {
        return m_type == TypeReference;
    }

References m_type, and TypeReference.

operator=()

FormulaToken & FormulaToken::operator=

(

const FormulaToken &

token

)

assignment operator

Definition at line 666 of file EnhancedPathFormula.cpp.

{
    if (this == &rhs) {
        return *this;
    }
 
    m_type = rhs.m_type;
    m_text = rhs.m_text;
    m_position = rhs.m_position;
 
    return *this;
}

References m_position, m_text, and m_type.

position()

int FormulaToken::position ( ) const

inline

Returns the position of the token.

Definition at line 59 of file EnhancedPathFormula.h.

    {
        return m_position;
    }

References m_position.

text()

QString FormulaToken::text ( ) const

inline

Returns the text representation of the token.

Definition at line 54 of file EnhancedPathFormula.h.

    {
        return m_text;
    }

References m_text.

type()

Type FormulaToken::type ( ) const

inline

Returns the type of the token.

Definition at line 49 of file EnhancedPathFormula.h.

    {
        return m_type;
    }

References m_type.

Member Data Documentation

m_position

int FormulaToken::m_position {-1}

private

the tokens position

Definition at line 92 of file EnhancedPathFormula.h.

{-1}; 

m_text

QString FormulaToken::m_text

private

the token text representation

Definition at line 91 of file EnhancedPathFormula.h.

m_type

Type FormulaToken::m_type {TypeUnknown}

private

the token type

Definition at line 90 of file EnhancedPathFormula.h.

{TypeUnknown};    

---

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

• plugins/flake/pathshapes/enhancedpath/EnhancedPathFormula.h
• plugins/flake/pathshapes/enhancedpath/EnhancedPathFormula.cpp