1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-09 18:50:54 +03:00
occt/src/Expr/Expr_NamedFunction.cdl
abv 6e33d3ced2 0024830: Remove redundant keyword 'mutable' in CDL declarations
Redundant keyword 'mutable' removed in CDL files.
In IGESConvGeom_GeomBuilder, unused methods MakeXY() and MakeXYZ() removed.
Method StepAP214_AutoDesignGroupAssignment::Init() replicating same method of the base class is removed as it causes CDL extraction error after above (seemingly irrelevant) changes.
2014-05-29 14:58:25 +04:00

122 lines
3.6 KiB
Plaintext

-- Created on: 1991-01-14
-- Created by: Arnaud BOUZY
-- Copyright (c) 1991-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class NamedFunction from Expr
inherits GeneralFunction from Expr
uses GeneralExpression from Expr,
NamedUnknown from Expr,
Array1OfReal from TColStd,
Array1OfNamedUnknown from Expr,
AsciiString from TCollection
raises OutOfRange from Standard,
DimensionMismatch from Standard,
NumericError from Standard,
NotEvaluable from Expr
is
Create( name : AsciiString;
exp : GeneralExpression;
vars : Array1OfNamedUnknown)
---Purpose: Creates a function of given variables <vars> with name
-- <name> defined by the expression <exp>.
---Level : Advanced
returns NamedFunction;
SetName(me : mutable; newname : AsciiString)
---Purpose: Sets the name <newname> to <me>.
---Level : Internal
is static;
GetName(me)
---Purpose: Returns the name assigned to <me>
---Level : Internal
returns AsciiString
is static;
NbOfVariables(me)
---Purpose: Returns the number of variables of <me>.
returns Integer
is static;
Variable(me ; index : Integer)
---Purpose: Returns the variable denoted by <index> in <me>.
-- Raises OutOfRange if <index> is greater than
-- NbOfVariables of <me>, or less than or equal to zero.
returns NamedUnknown
raises OutOfRange
is static;
Evaluate(me; vars : Array1OfNamedUnknown;
values : Array1OfReal)
---Purpose: Computes the value of <me> with the given variables.
-- Raises DimensionMismatch if Length(vars) is different from
-- Length(values).
returns Real
raises DimensionMismatch,NumericError,NotEvaluable;
Copy(me)
---Purpose: Returns a copy of <me> with the same form.
returns like me;
Derivative(me; var : NamedUnknown)
---Purpose: Returns Derivative of <me> for variable <var>.
returns GeneralFunction;
Derivative(me; var : NamedUnknown; deg : Integer)
---Purpose: Returns Derivative of <me> for variable <var> with
-- degree <deg>.
returns GeneralFunction;
IsIdentical(me; func : GeneralFunction)
---Purpose: Tests if <me> and <func> are similar functions (same
-- name and same used expression).
returns Boolean;
IsLinearOnVariable(me; index : Integer)
---Purpose: Tests if <me> is linear on variable on range <index>
returns Boolean;
GetStringName(me)
returns AsciiString from TCollection;
Expression(me)
---Purpose: Returns equivalent expression of <me>.
---Level : Internal
returns GeneralExpression
is static;
SetExpression(me : mutable; exp : GeneralExpression);
---Purpose: Modifies expression of <me>.
-- Warning: Beware of derivatives. See FunctionDerivative
---Level : Internal
fields
myName : AsciiString;
myExp : GeneralExpression;
myVariables : Array1OfNamedUnknown;
end NamedFunction;