Open CASCADE Technology  7.4.1.dev
Public Member Functions
Expr_NamedConstant Class Reference

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

#include <Expr_NamedConstant.hxx>

Inheritance diagram for Expr_NamedConstant:
Inheritance graph
[legend]

Public Member Functions

 Expr_NamedConstant (const TCollection_AsciiString &name, const Standard_Real value)
 Creates a constant value of name <name> and value . More...
 
Standard_Real GetValue () const
 
Standard_Integer NbSubExpressions () const override
 returns the number of sub-expressions contained in <me> (always returns zero) More...
 
const Handle< Expr_GeneralExpression > & SubExpression (const Standard_Integer I) const override
 returns the -th sub-expression of <me> raises OutOfRange More...
 
Handle< Expr_GeneralExpressionSimplified () const override
 returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation. More...
 
Handle< Expr_GeneralExpressionShallowSimplified () const override
 Returns a GeneralExpression after a simplification of the arguments of <me>. More...
 
Handle< Expr_GeneralExpressionCopy () const override
 Returns a copy of <me> having the same unknowns and functions. More...
 
Standard_Boolean ContainsUnknowns () const override
 Tests if <me> contains NamedUnknown. (returns always False) More...
 
Standard_Boolean Contains (const Handle< Expr_GeneralExpression > &exp) const override
 Tests if <exp> is contained in <me>. More...
 
Standard_Boolean IsLinear () const override
 Tests if <me> is linear on every NamedUnknown it contains. More...
 
Handle< Expr_GeneralExpressionDerivative (const Handle< Expr_NamedUnknown > &X) const override
 Returns the derivative on <X> unknown of <me> More...
 
virtual Handle< Expr_GeneralExpressionNDerivative (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. More...
 
void Replace (const Handle< Expr_NamedUnknown > &var, const Handle< Expr_GeneralExpression > &with) override
 Replaces all occurences of with <with> in <me> More...
 
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>. More...
 
- Public Member Functions inherited from Expr_NamedExpression
const TCollection_AsciiStringGetName () 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. More...
 
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. More...
 
TCollection_AsciiString String () const override
 returns a string representing <me> in a readable way. More...
 
- 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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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 occurences 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: