0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / DBC / DBC_BaseArray.cdl
1 -- Created on: 1996-01-29
2 -- Created by: Kernel
3 -- Copyright (c) 1996-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class BaseArray from DBC
18 inherits Storable from Standard
19
20 uses DBVArray from DBC
21
22 raises NullObject,
23     NegativeValue,
24     DimensionMismatch
25
26 is
27     Create returns BaseArray;
28     ---Purpose: Creates an BaseArray of NULL size
29     
30     Create (Size : Integer) returns BaseArray;
31     ---Purpose: Creates  an BaseArray of lower bound 0 and
32     --          upper bound <Size>-1.
33
34     Create (BaseArray: BaseArray) returns BaseArray;
35     ---Purpose: Creates an array which  is the copy of the given
36     --          argument.
37
38     ---C++: alias "  Standard_EXPORT virtual ~DBC_BaseArray();"
39
40     Length (me) returns Integer is static ;
41     ---C++: inline
42
43     Upper (me) returns Integer is static;
44     ---Purpose: Returns the upper bound
45     ---C++: inline
46               
47     Lock (me) returns Address is static ;
48     ---Purpose: Locks the array <me> in memory and 
49     --          returns its virtual address
50                 
51
52     Unlock (me) is static;
53     ---Purpose: unlocks the array <me> from memory
54
55 fields
56     mySize : Integer is protected;
57     myData : DBVArray from DBC is protected;
58 end BaseArray;