Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AZ::Dom::PathEntry Class Referencefinal

#include <DomPath.h>

Public Member Functions

 PathEntry (const PathEntry &)=default
 
 PathEntry (PathEntry &&)=default
 
 PathEntry (size_t value)
 
 PathEntry (AZ::Name value)
 
 PathEntry (AZStd::string_view value)
 
PathEntry & operator= (const PathEntry &)=default
 
PathEntry & operator= (PathEntry &&)=default
 
PathEntry & operator= (size_t value)
 
PathEntry & operator= (AZ::Name value)
 
PathEntry & operator= (AZStd::string_view value)
 
bool operator== (const PathEntry &other) const
 
bool operator== (size_t index) const
 
bool operator== (const AZ::Name &key) const
 
bool operator== (AZStd::string_view key) const
 
bool operator!= (const PathEntry &other) const
 
bool operator!= (size_t index) const
 
bool operator!= (const AZ::Name &key) const
 
bool operator!= (AZStd::string_view key) const
 
void SetEndOfArray ()
 
bool IsEndOfArray () const
 
bool IsIndex () const
 
bool IsKey () const
 
size_t GetIndex () const
 
const AZ::Name & GetKey () const
 
size_t GetHash () const
 

Static Public Attributes

static constexpr size_t EndOfArrayIndex = size_t(-1)
 

Detailed Description

Represents the path to a direct descendant of a Value. PathEntry may be one of the following:

  • Index, a numerical index for indexing within Arrays and Nodes
  • Key, a name for indexing within Objects and Nodes
  • EndOfArray, a special-case indicator for representing the end of an array used by the patching system to represent push / pop back operations.
The documentation for this class was generated from the following file: