OpenCascade.js
PackageApiSyntheticN collection autoGenerated

Generated (page 3 of 9)

OCCT package Generated: BRepToolsWrapper, GeomToolsWrapper, NCollection_Array1_AppParCurves_ConstraintCouple,…

NCollection_Array1_TCollection_ExtendedString

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
Examples:

Itemtab[100];//anexamplewithaCarray NCollection_Array1<Item>ttab(tab[0],1,100); NCollection_Array1<Item>tttab(ttab(10),10,20);//asliceofttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item>tab1(tab(tab.Lower()),1,tab.Length());

Warning: Programs client of such a 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++)

Zero-based (size_t) construction mode: Use NCollection_Array1(size_t theSize) or NCollection_Array1(pointer, size_t) to create a zero-based array (Lower()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variants do NOT own the memory and will not free it on destruction.

intaBuffer[100]; NCollection_Array1<int>aZero(100);//allocates,lower=0 NCollection_Array1<int>aWrap(aBuffer,100);//wrapsaBuffer,lower=0,notowner for(size_ti=0;i<aWrap.Size();++i) aWrap.At(i)=static_cast<int>(i);

Constructors(5)

Instance methods(23)

NCollection_Array1_TDF_Label

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
Examples:

Itemtab[100];//anexamplewithaCarray NCollection_Array1<Item>ttab(tab[0],1,100); NCollection_Array1<Item>tttab(ttab(10),10,20);//asliceofttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item>tab1(tab(tab.Lower()),1,tab.Length());

Warning: Programs client of such a 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++)

Zero-based (size_t) construction mode: Use NCollection_Array1(size_t theSize) or NCollection_Array1(pointer, size_t) to create a zero-based array (Lower()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variants do NOT own the memory and will not free it on destruction.

intaBuffer[100]; NCollection_Array1<int>aZero(100);//allocates,lower=0 NCollection_Array1<int>aWrap(aBuffer,100);//wrapsaBuffer,lower=0,notowner for(size_ti=0;i<aWrap.Size();++i) aWrap.At(i)=static_cast<int>(i);

Constructors(5)

Instance methods(23)

  • Init(theValue: TDF_Label): void

    Initialise the items with theValue.

    Parameters (1)
    • theValue
  • Size(): number

    Size query.

  • Length(): number

    Length query (legacy int-returning API).

  • IsEmpty(): boolean

    Return TRUE if array has zero length.

  • Lower(): number

    Lower bound.

  • Upper(): number

    Upper bound.

  • Assign(theOther: NCollection_Array1_TDF_Label): NCollection_Array1_TDF_Label

    Replaces this array by a copy of theOther array. Bounds and length are copied from theOther. When this array wraps an external (non-owned) buffer:

    • if theOther has the same length, values are copied in place into the external buffer and ownership is unchanged;
    • if theOther has a different length, this array detaches from the external buffer and allocates a fresh owned buffer. Use CopyValues() to preserve this array's bounds.
    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array1_TDF_Label): NCollection_Array1_TDF_Label

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array1_TDF_Label): NCollection_Array1_TDF_Label

    Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • First(): TDF_Label
    Returns

    first element

  • ChangeFirst(): TDF_Label
    Returns

    first element

  • Last(): TDF_Label
    Returns

    last element

  • ChangeLast(): TDF_Label
    Returns

    last element

  • Value(theIndex: number): TDF_Label

    Constant value access.

    Parameters (1)
    • theIndex
  • ChangeValue(theIndex: number): TDF_Label

    Variable value access.

    Parameters (1)
    • theIndex
  • At(theIndex: number): TDF_Label

    0-based checked access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • ChangeAt(theIndex: number): TDF_Label

    0-based checked mutable access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • SetValue(theIndex: number, theItem: TDF_Label): void

    Set value.

    Parameters (2)
    • theIndex
    • theItem
  • UpdateLowerBound(theLower: number): void

    Changes the lowest bound. Do not move data.

    Parameters (1)
    • theLower
  • UpdateUpperBound(theUpper: number): void

    Changes the upper bound. Do not move data.

    Parameters (1)
    • theUpper
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.

    Parameters (3)
    • theLower —
      new lower bound of array
    • theUpper —
      new upper bound of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to theSize elements, keeping the lower bound unchanged.

    Parameters (2)
    • theSize —
      new number of elements
    • theToCopyData —
      flag to copy existing data into new array
  • IsDeletable(): boolean

NCollection_Array1_TopoDS_Shape

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
Examples:

Itemtab[100];//anexamplewithaCarray NCollection_Array1<Item>ttab(tab[0],1,100); NCollection_Array1<Item>tttab(ttab(10),10,20);//asliceofttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item>tab1(tab(tab.Lower()),1,tab.Length());

Warning: Programs client of such a 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++)

Zero-based (size_t) construction mode: Use NCollection_Array1(size_t theSize) or NCollection_Array1(pointer, size_t) to create a zero-based array (Lower()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variants do NOT own the memory and will not free it on destruction.

intaBuffer[100]; NCollection_Array1<int>aZero(100);//allocates,lower=0 NCollection_Array1<int>aWrap(aBuffer,100);//wrapsaBuffer,lower=0,notowner for(size_ti=0;i<aWrap.Size();++i) aWrap.At(i)=static_cast<int>(i);

Constructors(5)

Instance methods(23)

  • Init(theValue: TopoDS_Shape): void

    Initialise the items with theValue.

    Parameters (1)
    • theValue
  • Size(): number

    Size query.

  • Length(): number

    Length query (legacy int-returning API).

  • IsEmpty(): boolean

    Return TRUE if array has zero length.

  • Lower(): number

    Lower bound.

  • Upper(): number

    Upper bound.

  • Assign(theOther: NCollection_Array1_TopoDS_Shape): NCollection_Array1_TopoDS_Shape

    Replaces this array by a copy of theOther array. Bounds and length are copied from theOther. When this array wraps an external (non-owned) buffer:

    • if theOther has the same length, values are copied in place into the external buffer and ownership is unchanged;
    • if theOther has a different length, this array detaches from the external buffer and allocates a fresh owned buffer. Use CopyValues() to preserve this array's bounds.
    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array1_TopoDS_Shape): NCollection_Array1_TopoDS_Shape

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array1_TopoDS_Shape): NCollection_Array1_TopoDS_Shape

    Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • First(): TopoDS_Shape
    Returns

    first element

  • ChangeFirst(): TopoDS_Shape
    Returns

    first element

  • Last(): TopoDS_Shape
    Returns

    last element

  • ChangeLast(): TopoDS_Shape
    Returns

    last element

  • Value(theIndex: number): TopoDS_Shape

    Constant value access.

    Parameters (1)
    • theIndex
  • ChangeValue(theIndex: number): TopoDS_Shape

    Variable value access.

    Parameters (1)
    • theIndex
  • At(theIndex: number): TopoDS_Shape

    0-based checked access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • ChangeAt(theIndex: number): TopoDS_Shape

    0-based checked mutable access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • SetValue(theIndex: number, theItem: TopoDS_Shape): void

    Set value.

    Parameters (2)
    • theIndex
    • theItem
  • UpdateLowerBound(theLower: number): void

    Changes the lowest bound. Do not move data.

    Parameters (1)
    • theLower
  • UpdateUpperBound(theUpper: number): void

    Changes the upper bound. Do not move data.

    Parameters (1)
    • theUpper
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.

    Parameters (3)
    • theLower —
      new lower bound of array
    • theUpper —
      new upper bound of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to theSize elements, keeping the lower bound unchanged.

    Parameters (2)
    • theSize —
      new number of elements
    • theToCopyData —
      flag to copy existing data into new array
  • IsDeletable(): boolean

NCollection_Array1_unsignedchar

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
Examples:

Itemtab[100];//anexamplewithaCarray NCollection_Array1<Item>ttab(tab[0],1,100); NCollection_Array1<Item>tttab(ttab(10),10,20);//asliceofttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item>tab1(tab(tab.Lower()),1,tab.Length());

Warning: Programs client of such a 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++)

Zero-based (size_t) construction mode: Use NCollection_Array1(size_t theSize) or NCollection_Array1(pointer, size_t) to create a zero-based array (Lower()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variants do NOT own the memory and will not free it on destruction.

intaBuffer[100]; NCollection_Array1<int>aZero(100);//allocates,lower=0 NCollection_Array1<int>aWrap(aBuffer,100);//wrapsaBuffer,lower=0,notowner for(size_ti=0;i<aWrap.Size();++i) aWrap.At(i)=static_cast<int>(i);

Constructors(5)

Instance methods(23)

  • Init(theValue: string): void

    Initialise the items with theValue.

    Parameters (1)
    • theValue
  • Size(): number

    Size query.

  • Length(): number

    Length query (legacy int-returning API).

  • IsEmpty(): boolean

    Return TRUE if array has zero length.

  • Lower(): number

    Lower bound.

  • Upper(): number

    Upper bound.

  • Assign(theOther: NCollection_Array1_unsignedchar): NCollection_Array1_unsignedchar

    Replaces this array by a copy of theOther array. Bounds and length are copied from theOther. When this array wraps an external (non-owned) buffer:

    • if theOther has the same length, values are copied in place into the external buffer and ownership is unchanged;
    • if theOther has a different length, this array detaches from the external buffer and allocates a fresh owned buffer. Use CopyValues() to preserve this array's bounds.
    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array1_unsignedchar): NCollection_Array1_unsignedchar

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array1_unsignedchar): NCollection_Array1_unsignedchar

    Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • First(): string
    Returns

    first element

  • ChangeFirst(): string
    Returns

    first element

  • Last(): string
    Returns

    last element

  • ChangeLast(): string
    Returns

    last element

  • Value(theIndex: number): string

    Constant value access.

    Parameters (1)
    • theIndex
  • ChangeValue(theIndex: number): string

    Variable value access.

    Parameters (1)
    • theIndex
  • At(theIndex: number): string

    0-based checked access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • ChangeAt(theIndex: number): string

    0-based checked mutable access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • SetValue(theIndex: number, theItem: string): void

    Set value.

    Parameters (2)
    • theIndex
    • theItem
  • UpdateLowerBound(theLower: number): void

    Changes the lowest bound. Do not move data.

    Parameters (1)
    • theLower
  • UpdateUpperBound(theUpper: number): void

    Changes the upper bound. Do not move data.

    Parameters (1)
    • theUpper
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.

    Parameters (3)
    • theLower —
      new lower bound of array
    • theUpper —
      new upper bound of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to theSize elements, keeping the lower bound unchanged.

    Parameters (2)
    • theSize —
      new number of elements
    • theToCopyData —
      flag to copy existing data into new array
  • IsDeletable(): boolean

NCollection_Array2_bool

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_bool): NCollection_Array2_bool

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_bool): NCollection_Array2_bool

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_bool): NCollection_Array2_bool

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: boolean): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_char

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_char): NCollection_Array2_char

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_char): NCollection_Array2_char

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_char): NCollection_Array2_char

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: string): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_double

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_double): NCollection_Array2_double

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_double): NCollection_Array2_double

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_double): NCollection_Array2_double

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: number): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_Extrema_POnCurv

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_Extrema_POnCurv): NCollection_Array2_Extrema_POnCurv

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_Extrema_POnCurv): NCollection_Array2_Extrema_POnCurv

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_Extrema_POnCurv): NCollection_Array2_Extrema_POnCurv

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Extrema_POnCurv): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_Extrema_POnCurv2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_Extrema_POnCurv2d): NCollection_Array2_Extrema_POnCurv2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_Extrema_POnCurv2d): NCollection_Array2_Extrema_POnCurv2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_Extrema_POnCurv2d): NCollection_Array2_Extrema_POnCurv2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Extrema_POnCurv2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_Extrema_POnSurf

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_Extrema_POnSurf): NCollection_Array2_Extrema_POnSurf

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_Extrema_POnSurf): NCollection_Array2_Extrema_POnSurf

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_Extrema_POnSurf): NCollection_Array2_Extrema_POnSurf

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Extrema_POnSurf): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_Extrema_POnSurfParams

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_Extrema_POnSurfParams): NCollection_Array2_Extrema_POnSurfParams

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_Extrema_POnSurfParams): NCollection_Array2_Extrema_POnSurfParams

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_Extrema_POnSurfParams): NCollection_Array2_Extrema_POnSurfParams

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Extrema_POnSurfParams): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_float

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_float): NCollection_Array2_float

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_float): NCollection_Array2_float

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_float): NCollection_Array2_float

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: number): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Circ2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Circ2d): NCollection_Array2_gp_Circ2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Circ2d): NCollection_Array2_gp_Circ2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Circ2d): NCollection_Array2_gp_Circ2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Circ2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Dir

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Dir): NCollection_Array2_gp_Dir

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Dir): NCollection_Array2_gp_Dir

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Dir): NCollection_Array2_gp_Dir

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Dir): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Dir2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Dir2d): NCollection_Array2_gp_Dir2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Dir2d): NCollection_Array2_gp_Dir2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Dir2d): NCollection_Array2_gp_Dir2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Dir2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Lin2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Lin2d): NCollection_Array2_gp_Lin2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Lin2d): NCollection_Array2_gp_Lin2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Lin2d): NCollection_Array2_gp_Lin2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Lin2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Pnt

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Pnt): NCollection_Array2_gp_Pnt

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Pnt): NCollection_Array2_gp_Pnt

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Pnt): NCollection_Array2_gp_Pnt

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Pnt): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Pnt2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Pnt2d): NCollection_Array2_gp_Pnt2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Pnt2d): NCollection_Array2_gp_Pnt2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Pnt2d): NCollection_Array2_gp_Pnt2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Pnt2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Vec

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Vec): NCollection_Array2_gp_Vec

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Vec): NCollection_Array2_gp_Vec

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Vec): NCollection_Array2_gp_Vec

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Vec): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_Vec2d

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_Vec2d): NCollection_Array2_gp_Vec2d

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_Vec2d): NCollection_Array2_gp_Vec2d

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_Vec2d): NCollection_Array2_gp_Vec2d

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_Vec2d): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_XY

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_XY): NCollection_Array2_gp_XY

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_XY): NCollection_Array2_gp_XY

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_XY): NCollection_Array2_gp_XY

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_XY): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_gp_XYZ

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_gp_XYZ): NCollection_Array2_gp_XYZ

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_gp_XYZ): NCollection_Array2_gp_XYZ

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_gp_XYZ): NCollection_Array2_gp_XYZ

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: gp_XYZ): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_Geom_BezierSurface

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_Geom_BezierSurface): NCollection_Array2_handle_Geom_BezierSurface

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_Geom_BezierSurface): NCollection_Array2_handle_Geom_BezierSurface

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_Geom_BezierSurface): NCollection_Array2_handle_Geom_BezierSurface

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Geom_BezierSurface): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_Geom_Surface

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_Geom_Surface): NCollection_Array2_handle_Geom_Surface

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_Geom_Surface): NCollection_Array2_handle_Geom_Surface

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_Geom_Surface): NCollection_Array2_handle_Geom_Surface

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Geom_Surface): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_MAT2d_Connexion

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_MAT2d_Connexion): NCollection_Array2_handle_MAT2d_Connexion

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_MAT2d_Connexion): NCollection_Array2_handle_MAT2d_Connexion

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_MAT2d_Connexion): NCollection_Array2_handle_MAT2d_Connexion

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: MAT2d_Connexion): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_NCollection_HArray1_double

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_NCollection_HArray1_double): NCollection_Array2_handle_NCollection_HArray1_double

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_NCollection_HArray1_double): NCollection_Array2_handle_NCollection_HArray1_double

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_NCollection_HArray1_double): NCollection_Array2_handle_NCollection_HArray1_double

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: unknown): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_NCollection_HArray1_int

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_NCollection_HArray1_int): NCollection_Array2_handle_NCollection_HArray1_int

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_NCollection_HArray1_int): NCollection_Array2_handle_NCollection_HArray1_int

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_NCollection_HArray1_int): NCollection_Array2_handle_NCollection_HArray1_int

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: unknown): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_Standard_Transient

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_Standard_Transient): NCollection_Array2_handle_Standard_Transient

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_Standard_Transient): NCollection_Array2_handle_Standard_Transient

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_Standard_Transient): NCollection_Array2_handle_Standard_Transient

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: Standard_Transient): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_StepElement_CurveElementPurposeMember

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_StepElement_CurveElementPurposeMember): NCollection_Array2_handle_StepElement_CurveElementPurposeMember

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_StepElement_CurveElementPurposeMember): NCollection_Array2_handle_StepElement_CurveElementPurposeMember

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_StepElement_CurveElementPurposeMember): NCollection_Array2_handle_StepElement_CurveElementPurposeMember

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: StepElement_CurveElementPurposeMember): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember): NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember): NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember): NCollection_Array2_handle_StepElement_SurfaceElementPurposeMember

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: StepElement_SurfaceElementPurposeMember): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_StepGeom_CartesianPoint

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: StepGeom_CartesianPoint): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_handle_StepGeom_SurfacePatch

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_handle_StepGeom_SurfacePatch): NCollection_Array2_handle_StepGeom_SurfacePatch

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_handle_StepGeom_SurfacePatch): NCollection_Array2_handle_StepGeom_SurfacePatch

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_handle_StepGeom_SurfacePatch): NCollection_Array2_handle_StepGeom_SurfacePatch

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: StepGeom_SurfacePatch): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_int

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_int): NCollection_Array2_int

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_int): NCollection_Array2_int

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_int): NCollection_Array2_int

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: number): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_StepElement_SurfaceElementPurpose

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_StepElement_SurfaceElementPurpose): NCollection_Array2_StepElement_SurfaceElementPurpose

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_StepElement_SurfaceElementPurpose): NCollection_Array2_StepElement_SurfaceElementPurpose

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_StepElement_SurfaceElementPurpose): NCollection_Array2_StepElement_SurfaceElementPurpose

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: StepElement_SurfaceElementPurpose): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_TopAbs_Orientation

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_TopAbs_Orientation): NCollection_Array2_TopAbs_Orientation

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_TopAbs_Orientation): NCollection_Array2_TopAbs_Orientation

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_TopAbs_Orientation): NCollection_Array2_TopAbs_Orientation

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: TopAbs_Orientation): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_Array2_TopoDS_Shape

Purpose: The class Array2 represents bi-dimensional arrays of fixed size known at run time. The ranges of indices are user defined.
Class allocates one 1D array storing full data (all Rows and Columns) and extra 1D array storing pointers to each Row.
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.LowerRow(); i <= A.UpperRow(); i++) for (j = A.LowerCol(); j <= A.UpperCol(); j++)
Zero-based (size_t) construction mode: NCollection_Array2(size_t theNbRows, size_t theNbCols) creates a zero-based array (LowerRow()==0, LowerCol()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variant NCollection_Array2(pointer, size_t, size_t) wraps an existing flat row-major buffer and does NOT own the memory.

Constructors(5)

Static methods(2)

  • BeginPosition(theRowLower: number, argNo1: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • argNo1
    • theColLower
    • theColUpper
  • LastPosition(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number): number
    Parameters (4)
    • theRowLower
    • theRowUpper
    • theColLower
    • theColUpper

Instance methods(28)

  • Size(): number

    Size (number of items).

  • Length(): number

    Length (legacy int-returning API).

  • NbRows(): number

    Returns number of rows.

  • NbColumns(): number

    Returns number of columns.

  • RowLength(): number

    Returns length of the row, i.e. number of columns.

  • ColLength(): number

    Returns length of the column, i.e. number of rows.

  • LowerRow(): number

    LowerRow.

  • UpperRow(): number

    UpperRow.

  • LowerCol(): number

    LowerCol.

  • UpperCol(): number

    UpperCol.

  • UpdateLowerRow(theLowerRow: number): void

    Updates lower row.

    Parameters (1)
    • theLowerRow
  • UpdateLowerCol(theLowerCol: number): void

    Updates lower column.

    Parameters (1)
    • theLowerCol
  • UpdateUpperRow(theUpperRow: number): void

    Updates upper row.

    Parameters (1)
    • theUpperRow
  • UpdateUpperCol(theUpperCol: number): void

    Updates upper column.

    Parameters (1)
    • theUpperCol
  • Assign(theOther: NCollection_Array2_TopoDS_Shape): NCollection_Array2_TopoDS_Shape

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • Assign(theOther: unknown): unknown

    Replaces this array by a copy of theOther array. Row and column bounds are copied from theOther.

    Parameters (1)
    • theOther
  • CopyValues(theOther: NCollection_Array2_TopoDS_Shape): NCollection_Array2_TopoDS_Shape

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • CopyValues(theOther: unknown): unknown

    Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same dimensions as theOther; otherwise exception Standard_DimensionMismatch is thrown.

    Parameters (1)
    • theOther
  • Move(theOther: NCollection_Array2_TopoDS_Shape): NCollection_Array2_TopoDS_Shape

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • Move(theOther: unknown): unknown

    Move assignment. This array will borrow all the data from theOther. The moved object will be left uninitialized and should not be used anymore.

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • SetValue(theRow: number, theCol: number, theItem: TopoDS_Shape): void

    SetValue.

    Parameters (3)
    • theRow
    • theCol
    • theItem
  • SetValue(theIndex: number, theItem: unknown): void

    SetValue.

    Parameters (2)
    • theIndex
    • theItem
  • Resize(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theLower: number, theUpper: number, theToCopyData: boolean): void

    Zero-based Resize: resizes to theNbRows x theNbCols, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theLower
    • theUpper
    • theToCopyData —
      flag to copy existing data into new array
  • Resize(theSize: number, theToCopyData: boolean): void

    Resizes the array to specified bounds. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies elements in linear (row-major) order. No re-allocation is done if dimensions are unchanged.

    Parameters (2)
    • theSize
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theRowLower: number, theRowUpper: number, theColLower: number, theColUpper: number, theToCopyData: boolean): void

    Resizes the array preserving 2D element layout. When theToCopyData is false, the array is re-allocated without preserving data. When theToCopyData is true, copies min(oldNbRows,newNbRows) x min(oldNbCols,newNbCols) elements from the top-left corner of the old array to the top-left corner of the new, preserving relative (row, col) offsets from lower bounds. Trimming or growing as needed. No re-allocation is done if dimensions are unchanged.

    Parameters (5)
    • theRowLower —
      new lower Row of array
    • theRowUpper —
      new upper Row of array
    • theColLower —
      new lower Column of array
    • theColUpper —
      new upper Column of array
    • theToCopyData —
      flag to copy existing data into new array
  • ResizeWithTrim(theNbRows: number, theNbCols: number, theToCopyData: boolean): void

    Zero-based ResizeWithTrim: resizes preserving 2D layout, keeping lower bounds unchanged. No re-allocation is done if dimensions are unchanged.

    Parameters (3)
    • theNbRows —
      new number of rows
    • theNbCols —
      new number of columns
    • theToCopyData —
      flag to copy existing data into new array

NCollection_DataMap_BRepGraph_NodeId_BRepGraph_NodeId

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: BRepGraph_NodeId, theItem: BRepGraph_NodeId): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: BRepGraph_NodeId, theItem: BRepGraph_NodeId): BRepGraph_NodeId

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: BRepGraph_NodeId, theItem: BRepGraph_NodeId): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: BRepGraph_NodeId, theItem: BRepGraph_NodeId): BRepGraph_NodeId

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: BRepGraph_NodeId): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: BRepGraph_NodeId): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: BRepGraph_NodeId): BRepGraph_NodeId

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: BRepGraph_NodeId): BRepGraph_NodeId

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: BRepGraph_NodeId): BRepGraph_NodeId

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_BRepGraph_NodeId_NCollection_DynamicArray_BRepGraph_NodeId

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_BRepGraph_RefUID_BRepGraph_RefId

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: BRepGraph_RefUID, theItem: BRepGraph_RefId): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: BRepGraph_RefUID, theItem: BRepGraph_RefId): BRepGraph_RefId

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: BRepGraph_RefUID, theItem: BRepGraph_RefId): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: BRepGraph_RefUID, theItem: BRepGraph_RefId): BRepGraph_RefId

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: BRepGraph_RefUID): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: BRepGraph_RefUID): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: BRepGraph_RefUID): BRepGraph_RefId

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: BRepGraph_RefUID): BRepGraph_RefId

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: BRepGraph_RefUID): BRepGraph_RefId

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_BRepGraph_UID_BRepGraph_NodeId

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: BRepGraph_UID, theItem: BRepGraph_NodeId): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: BRepGraph_UID, theItem: BRepGraph_NodeId): BRepGraph_NodeId

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: BRepGraph_UID, theItem: BRepGraph_NodeId): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: BRepGraph_UID, theItem: BRepGraph_NodeId): BRepGraph_NodeId

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: BRepGraph_UID): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: BRepGraph_UID): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: BRepGraph_UID): BRepGraph_NodeId

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: BRepGraph_UID): BRepGraph_NodeId

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: BRepGraph_UID): BRepGraph_NodeId

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_gp_Pnt_handle_Standard_Transient

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: gp_Pnt, theItem: Standard_Transient): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: gp_Pnt, theItem: Standard_Transient): Standard_Transient

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: gp_Pnt, theItem: Standard_Transient): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: gp_Pnt, theItem: Standard_Transient): Standard_Transient

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: gp_Pnt): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: gp_Pnt): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: gp_Pnt): Standard_Transient

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: gp_Pnt): Standard_Transient

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: gp_Pnt): Standard_Transient

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_handle_Standard_Transient_handle_Standard_Transient

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: Standard_Transient, theItem: Standard_Transient): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: Standard_Transient, theItem: Standard_Transient): Standard_Transient

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: Standard_Transient, theItem: Standard_Transient): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: Standard_Transient, theItem: Standard_Transient): Standard_Transient

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: Standard_Transient): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: Standard_Transient): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: Standard_Transient): Standard_Transient

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: Standard_Transient): Standard_Transient

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: Standard_Transient): Standard_Transient

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_handle_Standard_Transient_NCollection_List_Message_Msg

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_handle_StepRepr_RepresentationItem_TopoDS_Shape

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: StepRepr_RepresentationItem, theItem: TopoDS_Shape): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: StepRepr_RepresentationItem, theItem: TopoDS_Shape): TopoDS_Shape

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: StepRepr_RepresentationItem, theItem: TopoDS_Shape): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: StepRepr_RepresentationItem, theItem: TopoDS_Shape): TopoDS_Shape

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: StepRepr_RepresentationItem): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: StepRepr_RepresentationItem): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: StepRepr_RepresentationItem): TopoDS_Shape

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: StepRepr_RepresentationItem): TopoDS_Shape

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: StepRepr_RepresentationItem): TopoDS_Shape

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_handle_StepShape_TopologicalRepresentationItem_TopoDS_Shape

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_handle_TDF_Attribute_handle_TDF_Attribute

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TDF_Attribute, theItem: TDF_Attribute): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TDF_Attribute, theItem: TDF_Attribute): TDF_Attribute

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TDF_Attribute, theItem: TDF_Attribute): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TDF_Attribute, theItem: TDF_Attribute): TDF_Attribute

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TDF_Attribute): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TDF_Attribute): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TDF_Attribute): TDF_Attribute

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TDF_Attribute): TDF_Attribute

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TDF_Attribute): TDF_Attribute

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_handle_XCAFDimTolObjects_GeomToleranceObject_handle_XCAFDimTolObjects_DatumObject

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_handle_XCAFDoc_VisMaterial_handle_XCAFDoc_VisMaterial

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: XCAFDoc_VisMaterial, theItem: XCAFDoc_VisMaterial): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: XCAFDoc_VisMaterial, theItem: XCAFDoc_VisMaterial): XCAFDoc_VisMaterial

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: XCAFDoc_VisMaterial, theItem: XCAFDoc_VisMaterial): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: XCAFDoc_VisMaterial, theItem: XCAFDoc_VisMaterial): XCAFDoc_VisMaterial

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: XCAFDoc_VisMaterial): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: XCAFDoc_VisMaterial): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: XCAFDoc_VisMaterial): XCAFDoc_VisMaterial

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: XCAFDoc_VisMaterial): XCAFDoc_VisMaterial

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: XCAFDoc_VisMaterial): XCAFDoc_VisMaterial

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_bool

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: boolean): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: boolean): boolean

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: boolean): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: boolean): boolean

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): boolean

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): boolean

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): boolean

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_handle_MAT_BasicElt

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: MAT_BasicElt): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: MAT_BasicElt): MAT_BasicElt

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: MAT_BasicElt): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: MAT_BasicElt): MAT_BasicElt

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): MAT_BasicElt

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): MAT_BasicElt

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): MAT_BasicElt

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_NCollection_List_TopoDS_Shape

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: NCollection_List_TopoDS_Shape): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: NCollection_List_TopoDS_Shape): NCollection_List_TopoDS_Shape

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: NCollection_List_TopoDS_Shape): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: NCollection_List_TopoDS_Shape): NCollection_List_TopoDS_Shape

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): NCollection_List_TopoDS_Shape

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): NCollection_List_TopoDS_Shape

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): NCollection_List_TopoDS_Shape

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_NCollection_PackedMap_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: TColStd_PackedMapOfInteger): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: TColStd_PackedMapOfInteger): TColStd_PackedMapOfInteger

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: TColStd_PackedMapOfInteger): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: TColStd_PackedMapOfInteger): TColStd_PackedMapOfInteger

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): TColStd_PackedMapOfInteger

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): TColStd_PackedMapOfInteger

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): TColStd_PackedMapOfInteger

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_int_TopoDS_Shape

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: number, theItem: TopoDS_Shape): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: number, theItem: TopoDS_Shape): TopoDS_Shape

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: number, theItem: TopoDS_Shape): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: number, theItem: TopoDS_Shape): TopoDS_Shape

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: number): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: number): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: number): TopoDS_Shape

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: number): TopoDS_Shape

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: number): TopoDS_Shape

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_AsciiString_handle_Standard_Transient

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_AsciiString, theItem: Standard_Transient): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_AsciiString, theItem: Standard_Transient): Standard_Transient

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_AsciiString, theItem: Standard_Transient): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_AsciiString, theItem: Standard_Transient): Standard_Transient

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_AsciiString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_AsciiString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_AsciiString): Standard_Transient

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_AsciiString): Standard_Transient

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_AsciiString): Standard_Transient

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_AsciiString_handle_STEPCAFControl_ExternFile

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TCollection_AsciiString_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_AsciiString, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_AsciiString, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_AsciiString, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_AsciiString, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_AsciiString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_AsciiString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_AsciiString): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_AsciiString): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_AsciiString): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_AsciiString_RWObj_Material

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_AsciiString, theItem: RWObj_Material): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_AsciiString, theItem: RWObj_Material): RWObj_Material

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_AsciiString, theItem: RWObj_Material): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_AsciiString, theItem: RWObj_Material): RWObj_Material

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_AsciiString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_AsciiString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_AsciiString): RWObj_Material

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_AsciiString): RWObj_Material

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_AsciiString): RWObj_Material

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_AsciiString_TCollection_AsciiString

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TCollection_AsciiString_TopoDS_Shape

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_AsciiString, theItem: TopoDS_Shape): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_AsciiString, theItem: TopoDS_Shape): TopoDS_Shape

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_AsciiString, theItem: TopoDS_Shape): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_AsciiString, theItem: TopoDS_Shape): TopoDS_Shape

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_AsciiString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_AsciiString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_AsciiString): TopoDS_Shape

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_AsciiString): TopoDS_Shape

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_AsciiString): TopoDS_Shape

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_double

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_handle_CDM_MetaData

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: CDM_MetaData): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: CDM_MetaData): CDM_MetaData

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: CDM_MetaData): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: CDM_MetaData): CDM_MetaData

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): CDM_MetaData

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): CDM_MetaData

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): CDM_MetaData

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_handle_NCollection_HArray1_double

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: unknown): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: unknown): unknown

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: unknown): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: unknown): unknown

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): unknown

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): unknown

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): unknown

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_handle_NCollection_HArray1_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: unknown): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: unknown): unknown

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: unknown): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: unknown): unknown

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): unknown

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): unknown

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): unknown

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TCollection_ExtendedString_TCollection_ExtendedString

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TCollection_ExtendedString_unsignedchar

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TCollection_ExtendedString, theItem: string): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TCollection_ExtendedString, theItem: string): string

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TCollection_ExtendedString, theItem: string): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TCollection_ExtendedString, theItem: string): string

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TCollection_ExtendedString): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TCollection_ExtendedString): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TCollection_ExtendedString): string

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TCollection_ExtendedString): string

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TCollection_ExtendedString): string

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TDF_Label_int

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TDF_Label, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TDF_Label, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TDF_Label, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TDF_Label, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TDF_Label): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TDF_Label): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TDF_Label): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TDF_Label): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TDF_Label): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TDF_Label_TDF_Label

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: unknown): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): unknown

    Returns const reference to the hasher.

  • Assign(theOther: unknown): unknown

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TDF_Label, theItem: TDF_Label): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TDF_Label, theItem: TDF_Label): TDF_Label

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TDF_Label, theItem: TDF_Label): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TDF_Label, theItem: TDF_Label): TDF_Label

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TDF_Label): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TDF_Label): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TDF_Label): TDF_Label

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TDF_Label): TDF_Label

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TDF_Label): TDF_Label

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TopoDS_Shape_Bnd_Box_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_Bnd_Box2d_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_BOPDS_CoupleOfPaveBlocks_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_BRepOffset_Offset_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_BRepTopAdaptor_Tool_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: NCollection_DataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): TopTools_ShapeMapHasher

    Returns const reference to the hasher.

  • Assign(theOther: NCollection_DataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher): NCollection_DataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TopoDS_Shape, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TopoDS_Shape, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TopoDS_Shape, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TopoDS_Shape, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TopoDS_Shape): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TopoDS_Shape): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TopoDS_Shape): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TopoDS_Shape): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TopoDS_Shape): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TopoDS_Shape_gp_Pnt_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: NCollection_DataMap_TopoDS_Shape_gp_Pnt_TopTools_ShapeMapHasher): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): TopTools_ShapeMapHasher

    Returns const reference to the hasher.

  • Assign(theOther: NCollection_DataMap_TopoDS_Shape_gp_Pnt_TopTools_ShapeMapHasher): NCollection_DataMap_TopoDS_Shape_gp_Pnt_TopTools_ShapeMapHasher

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TopoDS_Shape, theItem: gp_Pnt): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TopoDS_Shape, theItem: gp_Pnt): gp_Pnt

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TopoDS_Shape, theItem: gp_Pnt): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TopoDS_Shape, theItem: gp_Pnt): gp_Pnt

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TopoDS_Shape): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TopoDS_Shape): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TopoDS_Shape): gp_Pnt

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TopoDS_Shape): gp_Pnt

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TopoDS_Shape): gp_Pnt

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TopoDS_Shape_gp_XYZ_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: NCollection_DataMap_TopoDS_Shape_gp_XYZ_TopTools_ShapeMapHasher): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): TopTools_ShapeMapHasher

    Returns const reference to the hasher.

  • Assign(theOther: NCollection_DataMap_TopoDS_Shape_gp_XYZ_TopTools_ShapeMapHasher): NCollection_DataMap_TopoDS_Shape_gp_XYZ_TopTools_ShapeMapHasher

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TopoDS_Shape, theItem: gp_XYZ): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TopoDS_Shape, theItem: gp_XYZ): gp_XYZ

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TopoDS_Shape, theItem: gp_XYZ): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TopoDS_Shape, theItem: gp_XYZ): gp_XYZ

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TopoDS_Shape): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TopoDS_Shape): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TopoDS_Shape): gp_XYZ

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TopoDS_Shape): gp_XYZ

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TopoDS_Shape): gp_XYZ

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TopoDS_Shape_handle_BRepTopAdaptor_TopolTool_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_handle_Geom_Surface_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_handle_NCollection_HArray2_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_handle_Standard_Transient_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_handle_StepBasic_ProductDefinition_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_handle_StepShape_ShapeDefinitionRepresentation_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_HLRTopoBRep_FaceData_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_int_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

  • Exchange(theOther: NCollection_DataMap_TopoDS_Shape_int_TopTools_ShapeMapHasher): void

    Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

    Parameters (1)
    • theOther —
      Mutated in place; read the updated value from this argument after the call.
  • GetHasher(): TopTools_ShapeMapHasher

    Returns const reference to the hasher.

  • Assign(theOther: NCollection_DataMap_TopoDS_Shape_int_TopTools_ShapeMapHasher): NCollection_DataMap_TopoDS_Shape_int_TopTools_ShapeMapHasher

    Assignment. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Bind(theKey: TopoDS_Shape, theItem: number): boolean

    Bind binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    true if Key was not bound already

  • Bound(theKey: TopoDS_Shape, theItem: number): number

    Bound binds Item to Key in map.

    Parameters (2)
    • theKey —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key (uses destroy+reconstruct)
    Returns

    pointer to modifiable Item

  • TryBind(theKey: TopoDS_Shape, theItem: number): boolean

    TryBind binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if Key was newly bound, false if Key already existed (no replacement)

  • TryBound(theKey: TopoDS_Shape, theItem: number): number

    TryBound binds Item to Key in map only if Key is not yet bound.

    Parameters (2)
    • theKey —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • IsBound(theKey: TopoDS_Shape): boolean

    IsBound.

    Parameters (1)
    • theKey
  • UnBind(theKey: TopoDS_Shape): boolean

    UnBind removes Item Key pair from map.

    Parameters (1)
    • theKey
  • Seek(theKey: TopoDS_Shape): number

    Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeSeek(theKey: TopoDS_Shape): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

    Parameters (1)
    • theKey
  • ChangeFind(theKey: TopoDS_Shape): number

    ChangeFind returns modifiable Item by Key. Raises if Key was not bound.

    Parameters (1)
    • theKey
  • Clear(doReleaseMemory: boolean): void

    Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

    Parameters (1)
    • doReleaseMemory
  • Clear(theAllocator: NCollection_BaseAllocator): void

    Clear data and reset allocator.

    Parameters (1)
    • theAllocator

NCollection_DataMap_TopoDS_Shape_NCollection_DataMap_TopoDS_Shape_NCollection_List_TopoDS_Shape_TopTools_ShapeMapHasher_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_BRepOffset_Interval_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_double_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_HLRTopoBRep_VData_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_int_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_Message_Msg_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_List_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Map_TopoDS_Shape_TopTools_ShapeMapHasher_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Sequence_double_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Sequence_gp_Pnt_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Sequence_gp_Pnt2d_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Sequence_handle_MAT_BasicElt_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_NCollection_Sequence_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_RWMesh_NodeAttributes_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)

NCollection_DataMap_TopoDS_Shape_TCollection_AsciiString_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
The DataMap can be seen as an extended array where the Keys are the indices. For this reason the operator () is defined on DataMap to fetch an Item from a Key. So the following syntax can be used :
anItem = aMap(aKey); aMap(aKey) = anItem;
This analogy has its limit. aMap(aKey) = anItem can be done only if aKey was previously bound to an item in the map.

Constructors(2)

Instance methods(15)