Describes any numeric constant known by a special name (as PI, e,...). More...

#include <Expr_NamedConstant.hxx>

Inheritance diagram for Expr_NamedConstant:

[legend]

Public Member Functions
	Expr_NamedConstant (const TCollection_AsciiString &name, const Standard_Real value)
	Creates a constant value of name <name> and value .

Standard_Real	GetValue () const

Standard_Integer	NbSubExpressions () const override
	returns the number of sub-expressions contained in <me> (always returns zero)

const Handle< Expr_GeneralExpression > &	SubExpression (const Standard_Integer I) const override
	returns the -th sub-expression of <me> raises OutOfRange

Handle< Expr_GeneralExpression >	Simplified () const override
	returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.

Handle< Expr_GeneralExpression >	ShallowSimplified () const override
	Returns a GeneralExpression after a simplification of the arguments of <me>.

Handle< Expr_GeneralExpression >	Copy () const override
	Returns a copy of <me> having the same unknowns and functions.

Standard_Boolean	ContainsUnknowns () const override
	Tests if <me> contains NamedUnknown. (returns always False)

Standard_Boolean	Contains (const Handle< Expr_GeneralExpression > &exp) const override
	Tests if <exp> is contained in <me>.

Standard_Boolean	IsLinear () const override
	Tests if <me> is linear on every NamedUnknown it contains.

Handle< Expr_GeneralExpression >	Derivative (const Handle< Expr_NamedUnknown > &X) const override
	Returns the derivative on <X> unknown of <me>

virtual Handle< Expr_GeneralExpression >	NDerivative (const Handle< Expr_NamedUnknown > &X, const Standard_Integer N) const override
	Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.

void	Replace (const Handle< Expr_NamedUnknown > &var, const Handle< Expr_GeneralExpression > &with) override
	Replaces all occurrences of with <with> in <me>

Standard_Real	Evaluate (const Expr_Array1OfNamedUnknown &vars, const TColStd_Array1OfReal &vals) const override
	Returns the value of <me> (as a Real) by replacement of <vars> by <vals>.

Public Member Functions inherited from Expr_NamedExpression
const TCollection_AsciiString &	GetName () const

void	SetName (const TCollection_AsciiString &name)

virtual Standard_Boolean	IsShareable () const override
	Tests if <me> can be shared by one or more expressions or must be copied. This method redefines to a True value the GeneralExpression method.

Standard_Boolean	IsIdentical (const Handle< Expr_GeneralExpression > &Other) const override
	Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.

TCollection_AsciiString	String () const override
	returns a string representing <me> in a readable way.

Public Member Functions inherited from Expr_GeneralExpression
Standard_Real	EvaluateNumeric () const
	Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Describes any numeric constant known by a special name (as PI, e,...).

Constructor & Destructor Documentation

◆ Expr_NamedConstant()

Expr_NamedConstant::Expr_NamedConstant	(	const TCollection_AsciiString &	name,
		const Standard_Real	value
	)

Creates a constant value of name <name> and value .

Member Function Documentation

◆ Contains()

Standard_Boolean Expr_NamedConstant::Contains ( const Handle< Expr_GeneralExpression > & exp ) const

overridevirtual

Tests if <exp> is contained in <me>.

Implements Expr_GeneralExpression.

◆ ContainsUnknowns()

Standard_Boolean Expr_NamedConstant::ContainsUnknowns ( ) const

overridevirtual

Tests if <me> contains NamedUnknown. (returns always False)

Implements Expr_GeneralExpression.

◆ Copy()

Handle< Expr_GeneralExpression > Expr_NamedConstant::Copy ( ) const

overridevirtual

Returns a copy of <me> having the same unknowns and functions.

Implements Expr_GeneralExpression.

◆ Derivative()

Handle< Expr_GeneralExpression > Expr_NamedConstant::Derivative ( const Handle< Expr_NamedUnknown > & X ) const

overridevirtual

Returns the derivative on <X> unknown of <me>

Implements Expr_GeneralExpression.

◆ Evaluate()

Standard_Real Expr_NamedConstant::Evaluate	(	const Expr_Array1OfNamedUnknown &	vars,
		const TColStd_Array1OfReal &	vals
	)		const

overridevirtual

Returns the value of <me> (as a Real) by replacement of <vars> by <vals>.

Implements Expr_GeneralExpression.

◆ GetValue()

Standard_Real Expr_NamedConstant::GetValue ( ) const

◆ IsLinear()

Standard_Boolean Expr_NamedConstant::IsLinear ( ) const

overridevirtual

Tests if <me> is linear on every NamedUnknown it contains.

Implements Expr_GeneralExpression.

◆ NbSubExpressions()

Standard_Integer Expr_NamedConstant::NbSubExpressions ( ) const

overridevirtual

returns the number of sub-expressions contained in <me> (always returns zero)

Implements Expr_GeneralExpression.

◆ NDerivative()

virtual Handle< Expr_GeneralExpression > Expr_NamedConstant::NDerivative	(	const Handle< Expr_NamedUnknown > &	X,
		const Standard_Integer	N
	)		const

overridevirtual

Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.

Reimplemented from Expr_GeneralExpression.

◆ Replace()

void Expr_NamedConstant::Replace	(	const Handle< Expr_NamedUnknown > &	var,
		const Handle< Expr_GeneralExpression > &	with
	)

overridevirtual

Replaces all occurrences of with <with> in <me>

Implements Expr_GeneralExpression.

◆ ShallowSimplified()

Handle< Expr_GeneralExpression > Expr_NamedConstant::ShallowSimplified ( ) const

overridevirtual

Returns a GeneralExpression after a simplification of the arguments of <me>.

Implements Expr_GeneralExpression.

◆ Simplified()

Handle< Expr_GeneralExpression > Expr_NamedConstant::Simplified ( ) const

overridevirtual

returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.

Implements Expr_GeneralExpression.

◆ SubExpression()

const Handle< Expr_GeneralExpression > & Expr_NamedConstant::SubExpression ( const Standard_Integer I ) const

overridevirtual

returns the -th sub-expression of <me> raises OutOfRange

Implements Expr_GeneralExpression.

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

Expr_NamedConstant.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Expr_NamedConstant()

Member Function Documentation

◆ Contains()

◆ ContainsUnknowns()

◆ Copy()

◆ Derivative()

◆ Evaluate()

◆ GetValue()

◆ IsLinear()

◆ NbSubExpressions()

◆ NDerivative()

◆ Replace()

◆ ShallowSimplified()

◆ Simplified()

◆ SubExpression()