FPropertyPairsMap Class Reference

#include <PropertyPairsMap.h>

Public Member Functions
void	AddProperty (FName InName, FName InValue=NAME_None)
bool	HasProperty (FName InName) const
bool	HasProperty (const TCHAR *InName) const
bool	GetProperty (FName InName, FName *OutValue=nullptr) const
bool	GetProperty (const TCHAR *InName, FName *OutValue=nullptr) const
bool	operator== (const FPropertyPairsMap &InOther) const
bool	operator!= (const FPropertyPairsMap &InOther) const
template<class Func >
void	ForEachProperty (Func InFunc)
bool	IsEmpty () const
int32	Num () const
FString	ToString () const

Protected Attributes
TMap< FName, FName >	Properties

Friends
FArchive &	operator<< (FArchive &InAr, FPropertyPairsMap &InPropertyPairsMap)

Detailed Description

A simple name/value pairs map

Member Function Documentation

AddProperty()

void FPropertyPairsMap::AddProperty ( FName  InName, FName  InValue = NAME_None  )

inline

Add a property/value pair to the map. This will replace any existing property with the new value.

Parameters

InName	Name of the property.
InValue	Optional value to be associated with the property.

ForEachProperty()

template<class Func >

void FPropertyPairsMap::ForEachProperty ( Func  InFunc )

inline

Iterate through the property map and invoke a functor that can optionally break iteration by returning false.

Parameters

InFunc

Function to invoke on the properties of the map.

GetProperty() [1/2]

bool FPropertyPairsMap::GetProperty ( const TCHAR *  InName, FName *  OutValue = nullptr  ) const

inline

GetProperty() [2/2]

bool FPropertyPairsMap::GetProperty ( FName  InName, FName *  OutValue = nullptr  ) const

inline

Gets the value associated with the provided property.

Parameters

InName

Name of the property. @out OutValue Value associated with the provided property.

Returns

True if the property exist in the map.

HasProperty() [1/2]

bool FPropertyPairsMap::HasProperty ( const TCHAR *  InName ) const

inline

HasProperty() [2/2]

bool FPropertyPairsMap::HasProperty ( FName  InName ) const

inline

Test if the provided property exists in the map.

Parameters

InName

Name of the property.

Returns

True if the property exist in the map.

IsEmpty()

bool FPropertyPairsMap::IsEmpty ( ) const

inline

Returns

True if the property map is empty.

Num()

int32 FPropertyPairsMap::Num ( ) const

inline

Returns

The number of properties in the map.

operator!=()

bool FPropertyPairsMap::operator!= ( const FPropertyPairsMap &  InOther ) const

inline

operator==()

bool FPropertyPairsMap::operator== ( const FPropertyPairsMap &  InOther ) const

inline

Compare this map with another for equality, ignoring ordering.

Parameters

InOther

Other property map to compare against.

Returns

True if the property maps contains the same properties and values.

ToString()

FString FPropertyPairsMap::ToString ( ) const

inline

Converts this property map to a string representation.

Returns

The string representation.

Friends And Related Symbol Documentation

operator<<

FArchive & operator<< ( FArchive &  InAr, FPropertyPairsMap &  InPropertyPairsMap  )

friend

Serialize this property map to the provided archive.

Parameters

Ar	Archive to serialize to.
InPropertyPairsMap	Property map to serialize.

Returns

Archive used to serialize the property map.

Member Data Documentation

Properties

TMap<FName, FName> FPropertyPairsMap::Properties

protected

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Engine/Public/PropertyPairsMap.h