[occt.git] / src / DDF / DDF.cdl

-- Created by: DAUTRY Philippe
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.

--      	-------

---Version:	0.0
--Version	Date		Purpose
--		0.0	Feb 10 1997	Creation


package DDF 

	---Purpose: Provides facilities to manipulate data framework
	--          in a Draw-Commands environment.

uses

    Standard,
    Draw,
    TCollection,
    TDF

is

    -- ----------------------------------------------------------------------
    -- Classes
    -- ----------------------------------------------------------------------

    class Data;
    	---Purpose : Encapsulates a data framework from TDF.

    class Browser;
    	---Purpose : Browses a data framework from TDF.

    class Transaction;
	---Purpose: Encapsulates a Transaction from TDF.

    class TransactionStack
    	instantiates Stack from TCollection (Transaction from DDF);

    -- ----------------------------------------------------------------------
    -- Package methods
    -- ----------------------------------------------------------------------


    GetDF (Name     : in out CString from Standard; 
           DF       : in out Data    from TDF;
           Complain : in     Boolean from Standard = Standard_True)
    returns Boolean;
   	---Purpose: Search in draw  directory the framewok  identified
   	--          by its name <Name>. returns True if found. In that
   	--          case <DF> is setted.


    FindLabel (DF      : in     Data    from TDF; 
    	      Entry    : in     CString from Standard;
	      Label    : in out Label   from TDF;
              Complain : in     Boolean from Standard = Standard_True)
    returns Boolean;
   	---Purpose: Search in <DF>  the label identified by its  entry
   	--          <Entry>.  returns  <True> if  found. In  that case
   	--          <Label> is setted.

    AddLabel (DF      : in     Data    from TDF;
    	      Entry   : in     CString from Standard; 
    	      Label   : in out Label   from TDF)
    returns  Boolean;
    	---Purpose : Search in <DF> the  label identified by its entry
    	--         <Entry>.   if label doesn't  exist, create  and add
    	--         the Label in <DF>. In that case return True.


    Find (DF       : in     Data      from TDF;
          Entry    : in     CString   from Standard;
    	  ID       : in     GUID      from Standard;
          A        : in out Attribute from TDF;
          Complain : Boolean from Standard = Standard_True)
    returns Boolean;
    	---Purpose: Search   in <DF> the  attribute  identified by its 
    	--          <ID> and its <entry>.  returns <True> if found. In
    	--          that case A is setted. 


    ReturnLabel(theCommands : in out Interpretor from Draw; L : Label from TDF)
    returns Interpretor from Draw;
    	---C++: return &

    -- ----------------------------------------------------------------------
    -- Commands
    -- ----------------------------------------------------------------------

    AllCommands   (theCommands : in out Interpretor from Draw);    


    BasicCommands (theCommands : in out Interpretor from Draw);    
    	---Purpose : Basic commands.

    DataCommands (theCommands : in out Interpretor from Draw);    
    	---Purpose : Data framework commands 
    	--           create, clear & copy.

    TransactionCommands (theCommands : in out Interpretor from Draw);    
    	---Purpose : open commit abort a transaction
    	--           undo facilities.

    BrowserCommands (theCommands : in out Interpretor from Draw);    
    	---Purpose : Browser commands .

end DDF;
Commit	Line	Data
b311480e	1	-- Created by: DAUTRY Philippe
	2	-- Copyright (c) 1997-1999 Matra Datavision
	3	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	4	--
	5	-- The content of this file is subject to the Open CASCADE Technology Public
	6	-- License Version 6.5 (the "License"). You may not use the content of this file
	7	-- except in compliance with the License. Please obtain a copy of the License
	8	-- at http://www.opencascade.org and read it completely before using this file.
	9	--
	10	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	11	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	12	--
	13	-- The Original Code and all software distributed under the License is
	14	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	15	-- Initial Developer hereby disclaims all such warranties, including without
	16	-- limitation, any warranties of merchantability, fitness for a particular
	17	-- purpose or non-infringement. Please see the License for the specific terms
	18	-- and conditions governing the rights and limitations under the License.
	19
7fd59977	20	-- -------
7fd59977	21
7fd59977	22	---Version: 0.0
b311480e	23	--Version Date Purpose
7fd59977	24	-- 0.0 Feb 10 1997 Creation
	25
	26
	27
	28	package DDF
	29
	30	---Purpose: Provides facilities to manipulate data framework
	31	-- in a Draw-Commands environment.
	32
	33	uses
	34
	35	Standard,
	36	Draw,
	37	TCollection,
	38	TDF
	39
	40	is
	41
	42	-- ----------------------------------------------------------------------
	43	-- Classes
	44	-- ----------------------------------------------------------------------
	45
	46	class Data;
	47	---Purpose : Encapsulates a data framework from TDF.
	48
	49	class Browser;
	50	---Purpose : Browses a data framework from TDF.
	51
	52	class Transaction;
	53	---Purpose: Encapsulates a Transaction from TDF.
	54
	55	class TransactionStack
	56	instantiates Stack from TCollection (Transaction from DDF);
	57
	58	-- ----------------------------------------------------------------------
	59	-- Package methods
	60	-- ----------------------------------------------------------------------
	61
	62
	63	GetDF (Name : in out CString from Standard;
	64	DF : in out Data from TDF;
	65	Complain : in Boolean from Standard = Standard_True)
	66	returns Boolean;
	67	---Purpose: Search in draw directory the framewok identified
	68	-- by its name <Name>. returns True if found. In that
	69	-- case <DF> is setted.
	70
	71
	72	FindLabel (DF : in Data from TDF;
	73	Entry : in CString from Standard;
	74	Label : in out Label from TDF;
	75	Complain : in Boolean from Standard = Standard_True)
	76	returns Boolean;
	77	---Purpose: Search in <DF> the label identified by its entry
	78	-- <Entry>. returns <True> if found. In that case
	79	-- <Label> is setted.
	80
	81	AddLabel (DF : in Data from TDF;
	82	Entry : in CString from Standard;
	83	Label : in out Label from TDF)
	84	returns Boolean;
	85	---Purpose : Search in <DF> the label identified by its entry
	86	-- <Entry>. if label doesn't exist, create and add
	87	-- the Label in <DF>. In that case return True.
88
89
90	Find (DF : in Data from TDF;
91	Entry : in CString from Standard;
92	ID : in GUID from Standard;
93	A : in out Attribute from TDF;
94	Complain : Boolean from Standard = Standard_True)
95	returns Boolean;
96	---Purpose: Search in <DF> the attribute identified by its
97	-- <ID> and its <entry>. returns <True> if found. In
98	-- that case A is setted.
99
100
101	ReturnLabel(theCommands : in out Interpretor from Draw; L : Label from TDF)
102	returns Interpretor from Draw;
103	---C++: return &
104
105	-- ----------------------------------------------------------------------
106	-- Commands
107	-- ----------------------------------------------------------------------
108
109	AllCommands (theCommands : in out Interpretor from Draw);
110
111
112	BasicCommands (theCommands : in out Interpretor from Draw);
113	---Purpose : Basic commands.
114
115	DataCommands (theCommands : in out Interpretor from Draw);
116	---Purpose : Data framework commands
117	-- create, clear & copy.
118
119	TransactionCommands (theCommands : in out Interpretor from Draw);
120	---Purpose : open commit abort a transaction
121	-- undo facilities.
122
123	BrowserCommands (theCommands : in out Interpretor from Draw);
124	---Purpose : Browser commands .
125
126	end DDF;
127
128
129