Files
OCCT/src/TCollection/TCollection_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

138 lines
4.8 KiB
Plaintext
Executable File

-- Copyright (c) 1998-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 TCollection
(ItemHArray1 as any;
TheArray1 as Array1 from TCollection(ItemHArray1))
inherits TShared
raises RangeError from Standard,
DimensionMismatch from Standard,
OutOfRange from Standard,
OutOfMemory from Standard
---Purpose: The class HArray1 represents unidimensionnal arrays
-- of fixed size dynamically dimensioned at construction time.
-- As with a C array, the access time to an HArray1 indexed
-- item is constant and is independent of the array size.
-- Arrays are commonly used as elementary data structures
-- for more complex objects.
-- HArray1 objects are handles to arrays.
-- - HArray1 arrays may be shared by several objects.
-- - You may use a TCollection_Array1 structure to have the actual array.
-- HArray1 is a generic class which depends on two parameters:
-- - Item, the type of element in the array,
-- - Array, the actual type of array handled by HArray1.
-- This is an instantiation with Item of the
-- TCollection_Array1 generic class.
-- Warning
-- HArray1 indexes start and end at a user-defined position.
-- Thus, when accessing an item, you must base the index on
-- the lower and upper bounds of the array.
is
Create (Low, Up: Integer from Standard)
returns mutable HArray1 from TCollection
---Purpose: Creates an array of lower bound <Low> and upper
-- bound <Up>. Range error is raised when <Up> is less than <Low>.
raises
RangeError from Standard,
OutOfMemory from Standard;
Create (Low, Up: Integer from Standard; V : ItemHArray1)
returns mutable HArray1 from TCollection
---Purpose: Creates an array of lower bound <Low> and upper
-- bound <Up>. Range error is raised when <Up> is less than <Low>.
raises
RangeError from Standard,
OutOfMemory from Standard;
Init(me : mutable; V : ItemHArray1);
---Purpose: Initialize the array with the value <V>
Length (me) returns Integer from Standard
---Level: Public
---Purpose: Returns the number of elements of <me>.
---C++: inline
is static ;
Lower (me) returns Integer from Standard
---Level: Public
---Purpose: Returns the lower bound.
---C++: inline
is static ;
Upper (me) returns Integer from Standard
---Level: Public
---Purpose: Returns the upper bound.
---C++: inline
is static ;
SetValue (me : mutable; Index: Integer from Standard; Value: ItemHArray1)
---Level: Public
---Purpose: Assigns the value <Value> to the <Index>th item of this array.
raises
OutOfRange from Standard
---C++: inline
is static ;
Value (me; Index:Integer from Standard) returns any ItemHArray1
---Level: Public
---Purpose: Returns the value of the <Index>th element of the array.
---C++: inline
---C++: return const &
raises
OutOfRange from Standard
is static ;
ChangeValue (me : mutable; Index:Integer from Standard) returns any
ItemHArray1
---Level: Public
---Purpose: Returns the value of the <Index>th element of the array.
---C++: inline
---C++: return &
raises
OutOfRange from Standard
is static ;
Array1(me) returns TheArray1
---Purpose: Returns the Array array used as a field by this array;
-- the returned array is not modifiable;
---C++: return const &
---C++: inline
is static;
ChangeArray1(me : mutable) returns TheArray1
---Purpose: Returns a modifiable reference on the Array array
-- used as a field by this array, in order to modify it.
---C++: return &
---C++: inline
is static;
fields
myArray : TheArray1;
end HArray1 ;