TraceSerialization Class Reference

This class contains methods to read and write TraceCollection. More...

#include <serialization.h>

Static Public Member Functions
static TRACE_API bool	Write (std::ostream &ostr, const std::shared_ptr< TraceCollection > &col)
	Writes col to ostr.
static TRACE_API bool	Write (std::ostream &ostr, const std::vector< std::shared_ptr< TraceCollection > > &collections)
	Writes collections to ostr.
static TRACE_API std::unique_ptr< TraceCollection >	Read (std::istream &istr, std::string *error=nullptr)
	Tries to create a TraceCollection from the contexts of istr.

Detailed Description

This class contains methods to read and write TraceCollection.

Definition at line 44 of file serialization.h.

Member Function Documentation

Read()

static TRACE_API std::unique_ptr< TraceCollection > Read ( std::istream &  istr, std::string *  error = nullptr  )

static

Tries to create a TraceCollection from the contexts of istr.

Returns a pointer to the created collection if it was successful. If there is an error reading istr, error will be populated with a description.

Write() [1/2]

static TRACE_API bool Write ( std::ostream &  ostr, const std::shared_ptr< TraceCollection > &  col  )

static

Writes col to ostr.

Returns true if the write was successful, false otherwise.

Write() [2/2]

static TRACE_API bool Write ( std::ostream &  ostr, const std::vector< std::shared_ptr< TraceCollection > > &  collections  )

static

Writes collections to ostr.

Returns true if the write was successful, false otherwise.

---

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

• pxr/base/trace/serialization.h