1. Epic GamesDeveloper
  3. TMultiMap

TMultiMap

A [TMapBase](API\Runtime\Core\Containers\TMapBase) specialization that allows multiple values to be associated with each key.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Containers

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Containers/Map.h
Include #include "Containers/Map.h"

Syntax

template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs>  
class TMultiMap : public TSortableMapBase< KeyType, ValueType, SetAllocator, KeyFuncs >

Remarks

A TMapBase specialization that allows multiple values to be associated with each key.

Constructors

  Type Name Description
Public function    
Public function    
Public function  

TMultiMap ( const TMultiMap&
)

  
Public function  

TMultiMap ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 Constructor for moving elements from a TMap with a different SetAllocator
Public function  

TMultiMap ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Constructor for copying elements from a TMap with a different SetAllocator
Public function  

TMultiMap ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList
)

 Constructor which gets its elements from a native initializer list
Public function    

Functions

  Type Name Description
Public function ValueType &

AddUnique ( const KeyType& InKey,
const ValueType& InValue
)

 Add a key-value association to the map.
Public function ValueType &

AddUnique ( const KeyType& InKey,
ValueType&& InValue
)

  
Public function ValueType &

AddUnique ( KeyType&& InKey,
const ValueType& InValue
)

  
Public function ValueType &

AddUnique ( KeyType&& InKey,
ValueType&& InValue
)

  
Public function void

Append ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& OtherMultiMap
)

 Move all items from another map into our map (if any keys are in both, the value from the other map wins) and empty the other map.
Public function void

Append ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& OtherMultiMap
)

 Add all items from another map to our map (if any keys are in both, the value from the other map wins).
Public function ValueType &

EmplaceUnique ( InitKeyType&& InKey,
InitValueType&& InValue
)

 Add a key-value association to the map.
Public function Const const ValueType * Find an association between a specified key and value. (const)
Public function ValueType * Find an association between a specified key and value.
Public function Const void

MultiFind ( KeyInitType Key,
TArray< ValueType, Allocator >& OutValues,
bool bMaintainOrder
)

 Finds all values associated with the specified key.
Public function void

MultiFindPointer ( KeyInitType Key,
TArray< ValueType*, Allocator >& OutValues,
bool bMaintainOrder
)

  
Public function Const void

MultiFindPointer ( KeyInitType Key,
TArray< const ValueType*, Allocator >& OutValues,
bool bMaintainOrder
)

 Finds all values associated with the specified key.
Public function Const int32

Num ( KeyInitType Key
)

 Returns the number of values within this map associated with the specified key
Public function Const int32

Num ()

 Since we implement an overloaded Num() function in TMultiMap, we need to reimplement TMapBase::Num to make it visible.
Public function int32 Remove all value associations for a key.
Public function int32

Remove ( KeyInitType InKey,
ValueInitType InValue
)

 Remove associations between the specified key and value from the map.
Public function int32 Remove the first association between the specified key and value from the map.

Operators

  Type Name Description
Public function TMultiMap &  
Public function TMultiMap &

operator= ( const TMultiMap&
)

  
Public function TMultiMap &

operator= ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 End - intrusive TOptional state //.
Public function TMultiMap &

operator= ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Assignment operator for copying elements from a TMap with a different SetAllocator
Public function TMultiMap &

operator= ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList
)

 Assignment operator which gets its elements from a native initializer list
Public function Const bool  

Typedefs

Name Description
IntrusiveUnsetOptionalStateType  
KeyConstPointerType  
KeyInitType  
Super  
ValueInitType  

Constants

Name Description
bHasIntrusiveUnsetOptionalState Start - intrusive TOptional state //.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page