libcascade
PackageApiSyntheticN collection autoGenerated

Generated (page 7 of 9)

OCCT package Generated:…

NCollection_HSequence_handle_Units_Token

Template class for Handle-managed sequences. Inherits from both NCollection_Sequence<TheItemType> and Standard_Transient, providing reference-counted sequence functionality.

Constructors(2)

Static methods(2)

Instance methods(6)

NCollection_HSequence_handle_Units_Unit

Template class for Handle-managed sequences. Inherits from both NCollection_Sequence<TheItemType> and Standard_Transient, providing reference-counted sequence functionality.

Constructors(2)

Static methods(2)

Instance methods(6)

NCollection_HSequence_int

Template class for Handle-managed sequences. Inherits from both NCollection_Sequence<TheItemType> and Standard_Transient, providing reference-counted sequence functionality.

Constructors(2)

Static methods(2)

Instance methods(6)

NCollection_IndexedDataMap_TCollection_AsciiString_handle_Standard_Transient

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TCollection_AsciiString_int

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

  • 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
  • Add(theKey1: TCollection_AsciiString, theItem: number): number

    Returns the Index of already bound Key or appends new Key with specified Item value.

    Parameters (2)
    • theKey1 —
      Key to search (and to bind, if it was not bound already)
    • theItem —
      Item value to set for newly bound Key; ignored if Key was already bound
    Returns

    index of Key

  • TryBound(theKey1: TCollection_AsciiString, theItem: number): number

    TryBound binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • TryBind(theKey1: TCollection_AsciiString, theItem: number): boolean

    TryBind binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if key was newly added, false if key already existed

  • Bind(theKey1: TCollection_AsciiString, theItem: number): boolean

    Bind binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    true if Key was not bound already

  • Bound(theKey1: TCollection_AsciiString, theItem: number): number

    Bound binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    pointer to modifiable Item

  • Contains(theKey1: TCollection_AsciiString): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TCollection_AsciiString, theItem: number): void

    Substitute.

    Parameters (3)
    • theIndex
    • theKey1
    • theItem
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TCollection_AsciiString): void

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TCollection_AsciiString

    FindKey.

    Parameters (1)
    • theIndex
  • FindFromIndex(theIndex: number): number

    FindFromIndex.

    Parameters (1)
    • theIndex
  • ChangeFromIndex(theIndex: number): number

    ChangeFromIndex.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TCollection_AsciiString): number

    FindIndex.

    Parameters (1)
    • theKey1
  • ChangeFromKey(theKey1: TCollection_AsciiString): number

    ChangeFromKey.

    Parameters (1)
    • theKey1
  • Seek(theKey1: TCollection_AsciiString): number

    Seek returns pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • ChangeSeek(theKey1: TCollection_AsciiString): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • 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_IndexedDataMap_TDF_Label_TopoDS_Shape

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

  • 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
  • Add(theKey1: TDF_Label, theItem: TopoDS_Shape): number

    Returns the Index of already bound Key or appends new Key with specified Item value.

    Parameters (2)
    • theKey1 —
      Key to search (and to bind, if it was not bound already)
    • theItem —
      Item value to set for newly bound Key; ignored if Key was already bound
    Returns

    index of Key

  • TryBound(theKey1: TDF_Label, theItem: TopoDS_Shape): TopoDS_Shape

    TryBound binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • TryBind(theKey1: TDF_Label, theItem: TopoDS_Shape): boolean

    TryBind binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if key was newly added, false if key already existed

  • Bind(theKey1: TDF_Label, theItem: TopoDS_Shape): boolean

    Bind binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    true if Key was not bound already

  • Bound(theKey1: TDF_Label, theItem: TopoDS_Shape): TopoDS_Shape

    Bound binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    pointer to modifiable Item

  • Contains(theKey1: TDF_Label): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TDF_Label, theItem: TopoDS_Shape): void

    Substitute.

    Parameters (3)
    • theIndex
    • theKey1
    • theItem
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TDF_Label): void

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TDF_Label

    FindKey.

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

    FindFromIndex.

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

    ChangeFromIndex.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TDF_Label): number

    FindIndex.

    Parameters (1)
    • theKey1
  • ChangeFromKey(theKey1: TDF_Label): TopoDS_Shape

    ChangeFromKey.

    Parameters (1)
    • theKey1
  • Seek(theKey1: TDF_Label): TopoDS_Shape

    Seek returns pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • ChangeSeek(theKey1: TDF_Label): TopoDS_Shape

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • 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_IndexedDataMap_TopoDS_Edge_Draft_EdgeInfo_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Face_Draft_FaceInfo_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Shape_BOPDS_CoupleOfPaveBlocks_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Shape_NCollection_List_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Shape_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Shape_XCAFPrs_Style_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

  • Exchange(theOther: NCollection_IndexedDataMap_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_IndexedDataMap_TopoDS_Shape_double_TopTools_ShapeMapHasher): NCollection_IndexedDataMap_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
  • Add(theKey1: TopoDS_Shape, theItem: number): number

    Returns the Index of already bound Key or appends new Key with specified Item value.

    Parameters (2)
    • theKey1 —
      Key to search (and to bind, if it was not bound already)
    • theItem —
      Item value to set for newly bound Key; ignored if Key was already bound
    Returns

    index of Key

  • TryBound(theKey1: TopoDS_Shape, theItem: number): number

    TryBound binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • TryBind(theKey1: TopoDS_Shape, theItem: number): boolean

    TryBind binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if key was newly added, false if key already existed

  • Bind(theKey1: TopoDS_Shape, theItem: number): boolean

    Bind binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    true if Key was not bound already

  • Bound(theKey1: TopoDS_Shape, theItem: number): number

    Bound binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    pointer to modifiable Item

  • Contains(theKey1: TopoDS_Shape): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TopoDS_Shape, theItem: number): void

    Substitute.

    Parameters (3)
    • theIndex
    • theKey1
    • theItem
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TopoDS_Shape): void

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TopoDS_Shape

    FindKey.

    Parameters (1)
    • theIndex
  • FindFromIndex(theIndex: number): number

    FindFromIndex.

    Parameters (1)
    • theIndex
  • ChangeFromIndex(theIndex: number): number

    ChangeFromIndex.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TopoDS_Shape): number

    FindIndex.

    Parameters (1)
    • theKey1
  • ChangeFromKey(theKey1: TopoDS_Shape): number

    ChangeFromKey.

    Parameters (1)
    • theKey1
  • Seek(theKey1: TopoDS_Shape): number

    Seek returns pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • ChangeSeek(theKey1: TopoDS_Shape): number

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • 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_IndexedDataMap_TopoDS_Shape_handle_Standard_Transient_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Vertex_Draft_VertexInfo_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_TopoDS_Vertex_NCollection_List_handle_ChFiDS_Stripe_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_handle_BOPDS_PaveBlock_NCollection_List_handle_BOPDS_PaveBlock

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedDataMap_handle_BOPDS_PaveBlock_NCollection_List_int

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

  • 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
  • Add(theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): number

    Returns the Index of already bound Key or appends new Key with specified Item value.

    Parameters (2)
    • theKey1 —
      Key to search (and to bind, if it was not bound already)
    • theItem —
      Item value to set for newly bound Key; ignored if Key was already bound
    Returns

    index of Key

  • TryBound(theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): NCollection_List_int

    TryBound binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • TryBind(theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): boolean

    TryBind binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if key was newly added, false if key already existed

  • Bind(theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): boolean

    Bind binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    true if Key was not bound already

  • Bound(theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): NCollection_List_int

    Bound binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    pointer to modifiable Item

  • Contains(theKey1: BOPDS_PaveBlock): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: BOPDS_PaveBlock, theItem: NCollection_List_int): void

    Substitute.

    Parameters (3)
    • theIndex
    • theKey1
    • theItem
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: BOPDS_PaveBlock): void

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): BOPDS_PaveBlock

    FindKey.

    Parameters (1)
    • theIndex
  • FindFromIndex(theIndex: number): NCollection_List_int

    FindFromIndex.

    Parameters (1)
    • theIndex
  • ChangeFromIndex(theIndex: number): NCollection_List_int

    ChangeFromIndex.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: BOPDS_PaveBlock): number

    FindIndex.

    Parameters (1)
    • theKey1
  • ChangeFromKey(theKey1: BOPDS_PaveBlock): NCollection_List_int

    ChangeFromKey.

    Parameters (1)
    • theKey1
  • Seek(theKey1: BOPDS_PaveBlock): NCollection_List_int

    Seek returns pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • ChangeSeek(theKey1: BOPDS_PaveBlock): NCollection_List_int

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • 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_IndexedDataMap_handle_Standard_Transient_handle_Standard_Transient

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

  • 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
  • Add(theKey1: Standard_Transient, theItem: Standard_Transient): number

    Returns the Index of already bound Key or appends new Key with specified Item value.

    Parameters (2)
    • theKey1 —
      Key to search (and to bind, if it was not bound already)
    • theItem —
      Item value to set for newly bound Key; ignored if Key was already bound
    Returns

    index of Key

  • TryBound(theKey1: Standard_Transient, theItem: Standard_Transient): Standard_Transient

    TryBound binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    reference to existing or newly bound Item

  • TryBind(theKey1: Standard_Transient, theItem: Standard_Transient): boolean

    TryBind binds Item to Key only if Key is not yet bound.

    Parameters (2)
    • theKey1 —
      key to add
    • theItem —
      item to bind if Key is not yet bound
    Returns

    true if key was newly added, false if key already existed

  • Bind(theKey1: Standard_Transient, theItem: Standard_Transient): boolean

    Bind binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    true if Key was not bound already

  • Bound(theKey1: Standard_Transient, theItem: Standard_Transient): Standard_Transient

    Bound binds Item to Key in map; overwrites value if Key already exists.

    Parameters (2)
    • theKey1 —
      key to add/update
    • theItem —
      new item; overrides value previously bound to the key
    Returns

    pointer to modifiable Item

  • Contains(theKey1: Standard_Transient): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: Standard_Transient, theItem: Standard_Transient): void

    Substitute.

    Parameters (3)
    • theIndex
    • theKey1
    • theItem
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: Standard_Transient): void

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): Standard_Transient

    FindKey.

    Parameters (1)
    • theIndex
  • FindFromIndex(theIndex: number): Standard_Transient

    FindFromIndex.

    Parameters (1)
    • theIndex
  • ChangeFromIndex(theIndex: number): Standard_Transient

    ChangeFromIndex.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: Standard_Transient): number

    FindIndex.

    Parameters (1)
    • theKey1
  • ChangeFromKey(theKey1: Standard_Transient): Standard_Transient

    ChangeFromKey.

    Parameters (1)
    • theKey1
  • Seek(theKey1: Standard_Transient): Standard_Transient

    Seek returns pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • ChangeSeek(theKey1: Standard_Transient): Standard_Transient

    ChangeSeek returns modifiable pointer to Item by Key. Returns NULL if Key was not found.

    Parameters (1)
    • theKey1
  • 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_IndexedDataMap_handle_Transfer_Finder_handle_Transfer_Binder_Transfer_FindHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1.. Extent. An Item is stored with each key.
This class is similar to IndexedMap from NCollection with the Item as a new feature. Note the important difference on the operator (). In the IndexedMap this operator returns the Key. In the IndexedDataMap this operator returns the Item.
See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(24)

NCollection_IndexedMap_Message_MetricType

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: Message_MetricType): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: Message_MetricType): Message_MetricType

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: Message_MetricType): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: Message_MetricType): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: Message_MetricType): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): Message_MetricType

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: Message_MetricType): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_IndexedMap_TCollection_AsciiString

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: TCollection_AsciiString): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: TCollection_AsciiString): TCollection_AsciiString

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: TCollection_AsciiString): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TCollection_AsciiString): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TCollection_AsciiString): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TCollection_AsciiString

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TCollection_AsciiString): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_IndexedMap_TDF_Label

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: TDF_Label): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: TDF_Label): TDF_Label

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: TDF_Label): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TDF_Label): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TDF_Label): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TDF_Label

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TDF_Label): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_IndexedMap_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

NCollection_IndexedMap_handle_BOPDS_PaveBlock

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: BOPDS_PaveBlock): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: BOPDS_PaveBlock): BOPDS_PaveBlock

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: BOPDS_PaveBlock): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: BOPDS_PaveBlock): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: BOPDS_PaveBlock): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): BOPDS_PaveBlock

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: BOPDS_PaveBlock): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_IndexedMap_handle_Standard_Transient

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: Standard_Transient): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: Standard_Transient): Standard_Transient

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: Standard_Transient): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: Standard_Transient): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: Standard_Transient): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): Standard_Transient

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: Standard_Transient): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_IndexedMap_handle_TDF_Attribute

NCollection_BaseMap

Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.

Constructors(4)

Instance methods(16)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(theExtent: number): void

    ReSize.

    Parameters (1)
    • theExtent
  • Add(theKey1: TDF_Attribute): number

    Add adds a new key to the map.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    index of the key (new or existing)

  • Added(theKey1: TDF_Attribute): TDF_Attribute

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing key.

    Parameters (1)
    • theKey1 —
      key to add
    Returns

    const reference to the key in the map

  • Contains(theKey1: TDF_Attribute): boolean

    Contains.

    Parameters (1)
    • theKey1
  • Substitute(theIndex: number, theKey1: TDF_Attribute): void

    Substitute.

    Parameters (2)
    • theIndex
    • theKey1
  • Swap(theIndex1: number, theIndex2: number): void

    Swaps two elements with the given indices.

    Parameters (2)
    • theIndex1
    • theIndex2
  • RemoveLast(): void

    RemoveLast.

  • RemoveFromIndex(theIndex: number): void

    Remove the key of the given index. Caution! The index of the last key can be changed.

    Parameters (1)
    • theIndex
  • RemoveKey(theKey1: TDF_Attribute): boolean

    Remove the given key. Caution! The index of the last key can be changed.

    Parameters (1)
    • theKey1
  • FindKey(theIndex: number): TDF_Attribute

    FindKey.

    Parameters (1)
    • theIndex
  • FindIndex(theKey1: TDF_Attribute): number

    FindIndex.

    Parameters (1)
    • theKey1
  • 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_List_BOPAlgo_CheckResult

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BOPDS_Pave

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BOPTools_ConnexityBlock

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BOPTools_CoupleOfShape

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BRepCheck_Status

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BRepFill_OffsetWire

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_BRepOffset_Interval

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_Bnd_Box

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): Bnd_Box

    First item.

  • Last(): Bnd_Box

    Last item.

  • Append(theItem: Bnd_Box): Bnd_Box

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_Bnd_Box): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_Bnd_Box): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_Bnd_Box): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_Bnd_Range

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): Bnd_Range

    First item.

  • Last(): Bnd_Range

    Last item.

  • Append(theItem: Bnd_Range): Bnd_Range

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_Bnd_Range): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_Bnd_Range): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_Bnd_Range): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_ChFiDS_Regul

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_HLRAlgo_BiPoint

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): HLRAlgo_BiPoint

    First item.

  • Last(): HLRAlgo_BiPoint

    Last item.

  • Append(theItem: HLRAlgo_BiPoint): HLRAlgo_BiPoint

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: unknown): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: unknown): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: unknown): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_HLRAlgo_Interference

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_HLRBRep_BiPnt2D

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_HLRBRep_BiPoint

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): HLRBRep_BiPoint

    First item.

  • Last(): HLRBRep_BiPoint

    Last item.

  • Append(theItem: HLRBRep_BiPoint): HLRBRep_BiPoint

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: unknown): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: unknown): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: unknown): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_HLRTopoBRep_VData

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_IntAna_Curve

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_IntPolyh_Couple

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_IntSurf_PntOn2S

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_IntTools_CurveRangeSample

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_IntTools_SurfaceRangeSample

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_Message_Msg

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_NCollection_IndexedDataMap_TopoDS_Shape_NCollection_List_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_NCollection_List_TopoDS_Shape

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_NCollection_Map_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_NCollection_Sequence_int

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_Plate_Plate

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_Poly_Triangle

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_Standard_GUID

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_TCollection_AsciiString

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_TCollection_ExtendedString

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_TDF_Label

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): TDF_Label

    First item.

  • Last(): TDF_Label

    Last item.

  • Append(theItem: TDF_Label): TDF_Label

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_TDF_Label): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_TDF_Label): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_TDF_Label): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_TopBas_TestInterference

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_TopoDS_Shape

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_double

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): number

    First item.

  • Last(): number

    Last item.

  • Append(theItem: number): number

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_double): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_double): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_double): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_gp_Pnt

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): gp_Pnt

    First item.

  • Last(): gp_Pnt

    Last item.

  • Append(theItem: gp_Pnt): gp_Pnt

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_gp_Pnt): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_gp_Pnt): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_gp_Pnt): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_handle_BOPDS_PaveBlock

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_BRepMesh_DiscretAlgoFactory

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_BRep_CurveRepresentation

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_BRep_PointRepresentation

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_CDM_Document

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_CDM_Reference

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_ChFiDS_ElSpine

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_ChFiDS_Stripe

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Expr_GeneralExpression

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Expr_GeneralFunction

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Expr_GeneralRelation

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Law_Function

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Message_Alert

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_NCollection_HArray1_double

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_NCollection_HSequence_gp_Pnt

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Poly_Triangulation

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_Standard_Transient

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_TDF_Attribute

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_TDF_AttributeDelta

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_TDF_Delta

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_handle_TNaming_NamedShape

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

NCollection_List_int

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): number

    First item.

  • Last(): number

    Last item.

  • Append(theItem: number): number

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_int): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_int): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_int): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_List_uint8_t

NCollection_BaseList

Purpose: Simple list to link items together keeping the first and the last one. Inherits BaseList, adding the data item to each node.

Constructors(4)

Instance methods(10)

  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear this list.

    Parameters (1)
    • theAllocator
  • First(): number

    First item.

  • Last(): number

    Last item.

  • Append(theItem: number): number

    Append one item at the end.

    Parameters (1)
    • theItem
  • Append(theOther: NCollection_List_uint8_t): void

    Append one item at the end.

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

    Prepend one item at the beginning.

    Parameters (1)
    • theItem
  • Prepend(theOther: NCollection_List_uint8_t): void

    Prepend one item at the beginning.

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

    RemoveFirst item.

  • Reverse(): void

    Reverse the list.

  • Exchange(theOther: NCollection_List_uint8_t): void

    Exchange the content of two lists without re-allocations. Swaps all internal state including allocators, ensuring correct deallocation. Existing iterators remain valid but will point to the other list's elements.

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

NCollection_Map_BOPDS_Pair

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: BOPDS_Pair): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: BOPDS_Pair): BOPDS_Pair

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: BOPDS_Pair): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: BOPDS_Pair): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_TCollection_AsciiString

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: TCollection_AsciiString): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: TCollection_AsciiString): TCollection_AsciiString

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: TCollection_AsciiString): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: TCollection_AsciiString): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_TDF_Label

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: TDF_Label): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: TDF_Label): TDF_Label

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: TDF_Label): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: TDF_Label): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_TopoDS_Shape_TopTools_ShapeMapHasher

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

NCollection_Map_handle_BOPDS_PaveBlock

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: BOPDS_PaveBlock): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: BOPDS_PaveBlock): BOPDS_PaveBlock

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: BOPDS_PaveBlock): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: BOPDS_PaveBlock): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_handle_TDF_Attribute

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: TDF_Attribute): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: TDF_Attribute): TDF_Attribute

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: TDF_Attribute): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: TDF_Attribute): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_handle_TNaming_NamedShape

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: TNaming_NamedShape): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: TNaming_NamedShape): TNaming_NamedShape

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: TNaming_NamedShape): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: TNaming_NamedShape): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_Map_int

NCollection_BaseMap

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.
The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.
To compute the hashcode of the key the function HashCode must be defined in the global namespace
To compare two keys the function IsEqual must be defined in the global namespace.
The performance of a Map is conditioned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.
If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Constructors(4)

Instance methods(21)

  • 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

    Assign. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • ReSize(N: number): void

    ReSize.

    Parameters (1)
    • N
  • Add(theKey: number): boolean

    Add.

    Parameters (1)
    • theKey
  • Added(theKey: number): number

    Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

    Parameters (1)
    • theKey
  • Contains(theKey: number): boolean

    Contains.

    Parameters (1)
    • theKey
  • Contains(theOther: unknown): boolean

    Checks if this map contains all keys of another map. This function checks if this map contains all keys of another map.

    Deprecated
    Parameters (1)
    • theOther
  • Remove(K: number): boolean

    Remove.

    Parameters (1)
    • K
  • 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
  • IsEqual(theOther: unknown): boolean

    Checks if two maps contain exactly the same keys. This function compares the keys of this map and another map and returns true if they contain exactly the same keys.

    Deprecated
    Parameters (1)
    • theOther
  • Union(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: unknown): boolean

    Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • HasIntersection(theMap: unknown): boolean

    Returns true if this and theMap have common elements.

    Deprecated
    Parameters (1)
    • theMap
  • Intersection(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: unknown): boolean

    Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Subtraction(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: unknown): boolean

    Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther
  • Difference(theLeft: unknown, theRight: unknown): void

    Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

    Deprecated
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: unknown): boolean

    Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

    Deprecated
    Parameters (1)
    • theOther

NCollection_PackedMap_int

Optimized Map for integer values of various integral types.
This template class provides a memory-efficient storage for sets of integers. Each block of BitsPerBlock (32 or 64) consecutive integers is stored compactly using bit manipulation. The block size is automatically selected based on the integer type: 32 bits for int/unsigned, 64 bits for int64_t/size_t.

Constructors(2)

Instance methods(25)

  • Assign(theOther: TColStd_PackedMapOfInteger): TColStd_PackedMapOfInteger

    Assignment operator.

    Parameters (1)
    • theOther
  • ReSize(theNbBuckets: number): void

    Resize the map.

    Parameters (1)
    • theNbBuckets
  • Clear(): void

    Clear the map.

  • Add(theKey: number): boolean

    Add a key to the map.

    Parameters (1)
    • theKey —
      the key to add
    Returns

    true if the key was added, false if it already existed

  • Contains(theKey: number): boolean

    Check if the map contains a key.

    Parameters (1)
    • theKey —
      the key to check
    Returns

    true if the key is in the map

  • Contains(theOther: TColStd_PackedMapOfInteger): boolean

    Check if the map contains a key.

    Parameters (1)
    • theOther
    Returns

    true if the key is in the map

  • Remove(theKey: number): boolean

    Remove a key from the map.

    Parameters (1)
    • theKey —
      the key to remove
    Returns

    true if the key was removed, false if it was not present

  • NbBuckets(): number

    Returns the number of map buckets.

  • Extent(): number

    Returns map extent (legacy int-returning API).

  • Length(): number

    Returns map extent (legacy int-returning API, synonym of Extent()).

  • Size(): number

    Returns map extent.

  • IsEmpty(): boolean

    Returns TRUE if map is empty.

  • GetMinimalMapped(): number

    Query the minimal contained key value.

  • GetMaximalMapped(): number

    Query the maximal contained key value.

  • Union(theLeft: TColStd_PackedMapOfInteger, theRight: TColStd_PackedMapOfInteger): void
    Parameters (2)
    • theLeft
    • theRight
  • Unite(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • Intersection(theLeft: TColStd_PackedMapOfInteger, theRight: TColStd_PackedMapOfInteger): void
    Parameters (2)
    • theLeft
    • theRight
  • Intersect(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • Subtraction(theLeft: TColStd_PackedMapOfInteger, theRight: TColStd_PackedMapOfInteger): void
    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • Difference(theLeft: TColStd_PackedMapOfInteger, theRight: TColStd_PackedMapOfInteger): void
    Parameters (2)
    • theLeft
    • theRight
  • Differ(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • IsEqual(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • IsSubset(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther
  • HasIntersection(theOther: TColStd_PackedMapOfInteger): boolean
    Parameters (1)
    • theOther

NCollection_Sequence_AppParCurves_MultiBSpCurve

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_AppParCurves_MultiCurve

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_BRepBlend_PointOnRst

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

  • Upper(): number

    Method for consistency with other collections.

    Returns

    Upper bound (inclusive) for iteration.

  • IsEmpty(): boolean

    Empty query.

  • Reverse(): void

    Reverse sequence.

  • Exchange(I: number, J: number): void

    Exchange two members.

    Parameters (2)
    • I
    • J
  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear the items out, take a new allocator if non null.

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

    Replace this sequence by the items of theOther. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • Remove(theIndex: number): void

    Remove one item.

    Parameters (1)
    • theIndex
  • Remove(theFromIndex: number, theToIndex: number): void

    Remove range of items.

    Parameters (2)
    • theFromIndex
    • theToIndex
  • Append(theItem: BRepBlend_PointOnRst): void

    Append one item.

    Parameters (1)
    • theItem
  • Append(theSeq: unknown): void

    Append one item.

    Parameters (1)
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • Prepend(theItem: BRepBlend_PointOnRst): void

    Prepend one item.

    Parameters (1)
    • theItem
  • Prepend(theSeq: unknown): void

    Prepend one item.

    Parameters (1)
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • InsertBefore(theIndex: number, theItem: BRepBlend_PointOnRst): void

    InsertBefore theIndex theItem.

    Parameters (2)
    • theIndex
    • theItem
  • InsertBefore(theIndex: number, theSeq: unknown): void
    Parameters (2)
    • theIndex
    • theSeq
  • InsertAfter(theIndex: number, theSeq: unknown): void

    InsertAfter the position of iterator.

    Parameters (2)
    • theIndex
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • InsertAfter(theIndex: number, theItem: BRepBlend_PointOnRst): void

    InsertAfter the position of iterator.

    Parameters (2)
    • theIndex
    • theItem
  • Split(theIndex: number, theSeq: unknown): void

    Split in two sequences.

    Parameters (2)
    • theIndex
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • First(): BRepBlend_PointOnRst

    First item access.

  • ChangeFirst(): BRepBlend_PointOnRst

    First item access.

  • Last(): BRepBlend_PointOnRst

    Last item access.

  • ChangeLast(): BRepBlend_PointOnRst

    Last item access.

  • Value(theIndex: number): BRepBlend_PointOnRst

    Constant item access by theIndex.

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

    Variable item access by theIndex.

    Parameters (1)
    • theIndex
  • SetValue(theIndex: number, theItem: BRepBlend_PointOnRst): void

    Set item value by theIndex.

    Parameters (2)
    • theIndex
    • theItem
  • At(theIndex: number): BRepBlend_PointOnRst

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

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

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

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

NCollection_Sequence_BRepExtrema_SolutionElem

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_BRepFill_EdgeFaceAndOrder

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_BRepFill_FaceAndOrder

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)