1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-30 12:14:08 +03:00
occt/src/PCollection/PCollection_HArray1.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

134 lines
4.5 KiB
Plaintext
Executable File

-- Created on: 1992-11-25
-- Created by: Jean Pierre TIRAULT
-- Copyright (c) 1992-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.
generic class HArray1 from PCollection (Item as Storable)
inherits Persistent
---Purpose: The class HArray1 represents unidimensionnal
-- array of fixed size known at run time.
-- The range of the index is user defined.
-- Warning: Programs clients of such class must be independent
-- of the range of the first element. Then, a C++ for
-- loop must be written like this
-- for (i = A->Lower(); i <= A->Upper(); i++)
uses
Integer from Standard,
Address from Standard
raises
OutOfRange from Standard,
RangeError from Standard
class FieldOfHArray1 instantiates VArray from DBC (Item);
is
Create (Low, Up: Integer from Standard) returns mutable HArray1
raises RangeError from Standard;
---Purpose: Creates an array of lower bound <Low> and
-- upper bound <Up>. Range error is raised
-- when <Up> is less than <Low>.
Create (Low, Up: Integer from Standard ; V : Item)
returns mutable HArray1
raises RangeError from Standard;
---Purpose: Creates an array of lower bound <Low> and
-- upper bound <Up>. Range error is raised
-- when <Up> is less than <Low>.
-- The Array is initialized with V
Length (me) returns Integer from Standard
is static ;
---Purpose: Returns the number of elements of <me>.
---Level: Public
---C++: inline
Lower (me) returns Integer from Standard
is static ;
---Purpose: Returns the lower bound.
---Level: Public
---C++: inline
SetValue (me : mutable; Index: Integer from Standard; Value: Item)
---Purpose: Assigns Value to the Index-th element of this array.
-- Example
-- PCollection_HArray1
-- myTable(1,100);
-- myTable->SetValue(3, 1551);
-- assert (myTable(3) == 1551);
-- Exceptions
-- Standard_OutOfRange if Index is not within the bounds of this array
raises OutOfRange from Standard
is static ;
---Purpose: Set the <Index>th element of the array to <Value>.
---Level: Public
Upper (me) returns Integer from Standard
is static ;
---Purpose: Returns the upper bound.
---Level: Public
---C++: inline
Value (me; Index: Integer from Standard) returns any Item
raises OutOfRange from Standard
is static;
---Purpose: Returns the value of the <Index>th element of the array.
-- Example
-- PCollection_HArray1
-- myTable(1,100);
-- myTable->SetValue(3, 1551);
-- Standard_Integer myItem =
-- myTable->Value(3);
-- Exceptions
-- Standard_OutOfRange if Index is not within the bounds of this array.
ShallowCopy(me)
returns mutable like me
is redefined;
---Purpose: Returns a new array containing a copy
-- of the values (of the elements) in this array.
ShallowDump (me; s: in out OStream)
is redefined;
---Level: Advanced
---C++: function call
Field (me)returns FieldOfHArray1
---Level: Internal
is private;
---Purpose: Private method that returns the field Data.
Datas(me) returns Address
---Level: Internal
is private;
fields
LowerBound : Integer from Standard ;
UpperBound : Integer from Standard ;
Data : FieldOfHArray1 ;
end HArray1 ;