[occt.git] / src / Law / Law_Linear.cdl

-- File:	Law_Linear.cdl
-- Created:	Thu Jan 12 10:36:44 1995
-- Author:	Laurent BOURESCHE
--		<lbo@phylox>
---Copyright:	 Matra Datavision 1995


class Linear from Law inherits Function from Law

	---Purpose: Describes an linear evolution law. 
uses
    Array1OfReal    from TColStd,
    Shape           from GeomAbs
      
raises OutOfRange from Standard

is

    Create
    
    	returns mutable Linear from Law;
    	---Purpose: Constructs an empty linear evolution law.

    Set(me: mutable; Pdeb,Valdeb,Pfin,Valfin: Real from Standard)
    	---Purpose:
    	-- Defines this linear evolution law by assigning both:
    	-- -   the bounds Pdeb and Pfin of the parameter, and
    	-- -   the values Valdeb and Valfin of the function at these
    	--   two parametric bounds.   
    	is static;
    Continuity(me) returns Shape from GeomAbs
    	---Purpose: Returns GeomAbs_CN
    is redefined static;
    
    NbIntervals(me; S : Shape from GeomAbs) returns Integer
	---Purpose: Returns  1
    is redefined static;
    
    Intervals(me; T : in out Array1OfReal from TColStd; 
    	          S : Shape from GeomAbs)
    raises
    	OutOfRange from Standard 
    is redefined static;


    Value(me: mutable; X: Real from Standard)
    
    	returns Real from Standard;
	---Purpose: Returns the value of this function at the point of parameter X.

    D1(me: mutable; X: Real from Standard; F,D: out Real from Standard); 
    	---Purpose:
    	-- Returns the value F and the first derivative D of this
    	-- function at the point of parameter X.    
    D2(me: mutable; X: Real from Standard; 
       F,D, D2: out Real from Standard);
    	---Purpose: Returns the value, first and second derivatives 
    	--          at parameter X.
    
    Trim(me; PFirst, PLast, Tol :Real from Standard) returns Function
    
    	---Purpose:   Returns a  law equivalent of  <me>  between
	--        parameters <First>  and <Last>. <Tol>  is used  to
	--        test for 3d points confusion.
	--        It is usfule to determines the derivatives 
	--        in these values <First> and <Last> if 
        --        the Law is not Cn.          
    	is redefined static;

    Bounds(me: mutable; PFirst,PLast: out Real from Standard);
    	---Purpose: Returns the parametric bounds of the function.    

fields

    valdeb  : Real from Standard;
    valfin  : Real from Standard;
    pdeb    : Real from Standard;
    pfin    : Real from Standard;

end Linear;
Commit	Line	Data
7fd59977	1	-- File: Law_Linear.cdl
	2	-- Created: Thu Jan 12 10:36:44 1995
	3	-- Author: Laurent BOURESCHE
	4	-- <lbo@phylox>
	5	---Copyright: Matra Datavision 1995
	6
	7
	8
	9	class Linear from Law inherits Function from Law
	10
	11	---Purpose: Describes an linear evolution law.
	12	uses
	13	Array1OfReal from TColStd,
	14	Shape from GeomAbs
	15
	16	raises OutOfRange from Standard
	17
	18	is
	19
	20	Create
	21
	22	returns mutable Linear from Law;
	23	---Purpose: Constructs an empty linear evolution law.
	24
	25	Set(me: mutable; Pdeb,Valdeb,Pfin,Valfin: Real from Standard)
	26	---Purpose:
	27	-- Defines this linear evolution law by assigning both:
	28	-- - the bounds Pdeb and Pfin of the parameter, and
	29	-- - the values Valdeb and Valfin of the function at these
	30	-- two parametric bounds.
	31	is static;
	32	Continuity(me) returns Shape from GeomAbs
	33	---Purpose: Returns GeomAbs_CN
	34	is redefined static;
	35
	36	NbIntervals(me; S : Shape from GeomAbs) returns Integer
	37	---Purpose: Returns 1
	38	is redefined static;
	39
	40	Intervals(me; T : in out Array1OfReal from TColStd;
	41	S : Shape from GeomAbs)
	42	raises
	43	OutOfRange from Standard
	44	is redefined static;
	45
	46
	47
	48	Value(me: mutable; X: Real from Standard)
	49
	50	returns Real from Standard;
	51	---Purpose: Returns the value of this function at the point of parameter X.
	52
	53	D1(me: mutable; X: Real from Standard; F,D: out Real from Standard);
	54	---Purpose:
	55	-- Returns the value F and the first derivative D of this
	56	-- function at the point of parameter X.
	57	D2(me: mutable; X: Real from Standard;
	58	F,D, D2: out Real from Standard);
	59	---Purpose: Returns the value, first and second derivatives
	60	-- at parameter X.
	61
	62	Trim(me; PFirst, PLast, Tol :Real from Standard) returns Function
	63
	64	---Purpose: Returns a law equivalent of <me> between
65	-- parameters <First> and <Last>. <Tol> is used to
66	-- test for 3d points confusion.
67	-- It is usfule to determines the derivatives
68	-- in these values <First> and <Last> if
69	-- the Law is not Cn.
70	is redefined static;
71
72	Bounds(me: mutable; PFirst,PLast: out Real from Standard);
73	---Purpose: Returns the parametric bounds of the function.
74
75	fields
76
77	valdeb : Real from Standard;
78	valfin : Real from Standard;
79	pdeb : Real from Standard;
80	pfin : Real from Standard;
81
82	end Linear;