TraceEventList Class Reference

This class represents an ordered collection of TraceEvents and the TraceDynamicKeys and data that the events reference. More...

Public Member Functions

TRACE_API TraceEventList ()
 Constructor. More...
 
 TraceEventList (TraceEventList &&)=default
 Move Constructor. More...
 
TraceEventListoperator= (TraceEventList &&)=default
 Move Assignment. More...
 
 TraceEventList (const TraceEventList &)=delete
 
TraceEventListoperator= (const TraceEventList &)=delete
 
bool IsEmpty () const
 Returns whether there are any events in the list. More...
 
template<class... Args>
const TraceEventEmplaceBack (Args &&... args)
 Construct a TraceEvent at the end on the list. More...
 
TraceKey CacheKey (const TraceDynamicKey &key)
 For speed the TraceEvent class holds a pointer to a TraceStaticKeyData. More...
 
TRACE_API void Append (TraceEventList &&other)
 Appends the given list to the end of this list. More...
 
template<typename T >
decltype(std::declval< TraceDataBuffer >().StoreData(std::declval< T >())) StoreData (const T &value)
 Copy data to the buffer and return a pointer to the cached data that is valid for the lifetime of the Eventlist. More...
 

Iterator support.

using const_iterator = TraceEventContainer::const_iterator
 
using const_reverse_iterator = TraceEventContainer::const_reverse_iterator
 
const_iterator begin () const
 
const_iterator end () const
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator rend () const
 

Detailed Description

This class represents an ordered collection of TraceEvents and the TraceDynamicKeys and data that the events reference.

Definition at line 46 of file eventList.h.

Constructor & Destructor Documentation

◆ TraceEventList() [1/2]

TRACE_API TraceEventList ( )

Constructor.

◆ TraceEventList() [2/2]

TraceEventList ( TraceEventList &&  )
default

Move Constructor.

Member Function Documentation

◆ Append()

TRACE_API void Append ( TraceEventList &&  other)

Appends the given list to the end of this list.

This object will take ownership of the events and keys in the appended list.

◆ CacheKey()

TraceKey CacheKey ( const TraceDynamicKey key)
inline

For speed the TraceEvent class holds a pointer to a TraceStaticKeyData.

This method creates a key which can be referenced by events in this container. Returns a TraceKey which will remain valid for the lifetime of the container.

Definition at line 86 of file eventList.h.

◆ EmplaceBack()

const TraceEvent& EmplaceBack ( Args &&...  args)
inline

Construct a TraceEvent at the end on the list.

Returns a reference to the newly constructed event.

Definition at line 78 of file eventList.h.

◆ IsEmpty()

bool IsEmpty ( ) const
inline

Returns whether there are any events in the list.

Definition at line 73 of file eventList.h.

◆ operator=()

TraceEventList& operator= ( TraceEventList &&  )
default

Move Assignment.

◆ StoreData()

decltype(std::declval<TraceDataBuffer>().StoreData(std::declval<T>())) StoreData ( const T &  value)
inline

Copy data to the buffer and return a pointer to the cached data that is valid for the lifetime of the Eventlist.

Definition at line 99 of file eventList.h.


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