TraceEventList Class Reference

#include <eventList.h>

Public Member Functions
TRACE_API	TraceEventList ()
	Constructor. More...
	TraceEventList (TraceEventList &&)=default
	Move Constructor. More...
TraceEventList &	operator= (TraceEventList &&)=default
	Move Assignment. More...
	TraceEventList (const TraceEventList &)=delete
TraceEventList &	operator= (const TraceEventList &)=delete
bool	IsEmpty () const
	Returns whether there are any events in the list. More...
template<class... Args>
const TraceEvent &	EmplaceBack (Args &&...args)
TraceKey	CacheKey (const TraceDynamicKey &key)
TRACE_API void	Append (TraceEventList &&other)
template<typename T >
decltype(std::declval < TraceDataBuffer > ().StoreData(std::declval< T >()))	StoreData (const T &value)

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 29 of file eventList.h.

Member Typedef Documentation

using TraceEventList::const_iterator = TraceEventContainer::const_iterator

Definition at line 46 of file eventList.h.

using TraceEventList::const_reverse_iterator = TraceEventContainer::const_reverse_iterator

Definition at line 50 of file eventList.h.

Constructor & Destructor Documentation

TRACE_API TraceEventList::TraceEventList

(

)

Constructor.

TraceEventList::TraceEventList ( TraceEventList &&  )

default

Move Constructor.

TraceEventList::TraceEventList ( const TraceEventList &  )

delete

Member Function Documentation

TRACE_API void TraceEventList::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.

const_iterator TraceEventList::begin ( void  ) const

inline

Definition at line 47 of file eventList.h.

TraceKey TraceEventList::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 69 of file eventList.h.

template<class... Args>

const TraceEvent& TraceEventList::EmplaceBack ( Args &&...  args )

inline

Construct a TraceEvent at the end on the list. Returns a reference to the newly constructed event.

Definition at line 61 of file eventList.h.

const_iterator TraceEventList::end ( void  ) const

inline

Definition at line 48 of file eventList.h.

bool TraceEventList::IsEmpty ( ) const

inline

Returns whether there are any events in the list.

Definition at line 56 of file eventList.h.

TraceEventList& TraceEventList::operator= ( TraceEventList &&  )

default

Move Assignment.

TraceEventList& TraceEventList::operator= ( const TraceEventList &  )

delete

const_reverse_iterator TraceEventList::rbegin ( ) const

inline

Definition at line 51 of file eventList.h.

const_reverse_iterator TraceEventList::rend ( ) const

inline

Definition at line 52 of file eventList.h.

template<typename T >

decltype(std::declval<TraceDataBuffer>().StoreData(std::declval<T>())) TraceEventList::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 82 of file eventList.h.

---

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

• pxr/base/trace/eventList.h