TraceEventData Class Reference

This class holds data that can be stored in TraceEvents. More...

#include <eventData.h>

Public Member Functions
	TraceEventData ()
	Ctor for Invalid type.
	TraceEventData (bool b)
	Ctor for Bool type.
	TraceEventData (int64_t i)
	Ctor for Int type.
	TraceEventData (uint64_t i)
	Ctor for UInt type.
	TraceEventData (double d)
	Ctor for Float type.
	TraceEventData (const std::string &s)
	Ctor for String type.
TRACE_API TraceEvent::DataType	GetType () const
	Returns the Type of the data stored.
TRACE_API const int64_t *	GetInt () const
	Returns a pointer to the data or nullptr if the type is not Int.
TRACE_API const uint64_t *	GetUInt () const
	Returns a pointer to the data or nullptr if the type is not UInt.
TRACE_API const double *	GetFloat () const
	Returns a pointer to the data or nullptr if the type is not Float.
TRACE_API const bool *	GetBool () const
	Returns a pointer to the data or nullptr if the type is not Bool.
TRACE_API const std::string *	GetString () const
	Returns a pointer to the data or nullptr if the type is not String.
TRACE_API void	WriteJson (JsWriter &) const
	Writes a json representation of the data.

Detailed Description

This class holds data that can be stored in TraceEvents.

Definition at line 45 of file eventData.h.

Constructor & Destructor Documentation

TraceEventData() [1/6]

TraceEventData ( )

inline

Ctor for Invalid type.

Definition at line 48 of file eventData.h.

TraceEventData() [2/6]

TraceEventData ( bool  b )

inlineexplicit

Ctor for Bool type.

Definition at line 51 of file eventData.h.

TraceEventData() [3/6]

TraceEventData ( int64_t  i )

inlineexplicit

Ctor for Int type.

Definition at line 54 of file eventData.h.

TraceEventData() [4/6]

TraceEventData ( uint64_t  i )

inlineexplicit

Ctor for UInt type.

Definition at line 57 of file eventData.h.

TraceEventData() [5/6]

TraceEventData ( double  d )

inlineexplicit

Ctor for Float type.

Definition at line 60 of file eventData.h.

TraceEventData() [6/6]

TraceEventData ( const std::string &  s )

inlineexplicit

Ctor for String type.

Definition at line 63 of file eventData.h.

Member Function Documentation

GetBool()

TRACE_API const bool * GetBool

(

)

const

Returns a pointer to the data or nullptr if the type is not Bool.

GetFloat()

TRACE_API const double * GetFloat

(

)

const

Returns a pointer to the data or nullptr if the type is not Float.

GetInt()

TRACE_API const int64_t * GetInt

(

)

const

Returns a pointer to the data or nullptr if the type is not Int.

GetString()

TRACE_API const std::string * GetString

(

)

const

Returns a pointer to the data or nullptr if the type is not String.

GetType()

TRACE_API TraceEvent::DataType GetType

(

)

const

Returns the Type of the data stored.

GetUInt()

TRACE_API const uint64_t * GetUInt

(

)

const

Returns a pointer to the data or nullptr if the type is not UInt.

WriteJson()

TRACE_API void WriteJson

(

JsWriter &

)

const

Writes a json representation of the data.

---

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

• pxr/base/trace/eventData.h