Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
SdfCrateInfo Class Reference

A class for introspecting the underlying qualities of .usdc 'crate' files, for diagnostic purposes. More...

#include <crateInfo.h>

Public Member Functions

SDF_API SummaryStats GetSummaryStats () const
 Return summary statistics structure for this file.
 
SDF_API std::vector< Section > GetSections () const
 Return the named file sections, their location and sizes in the file.
 
SDF_API TfToken GetFileVersion () const
 Return the file version.
 
SDF_API TfToken GetSoftwareVersion () const
 Return the software version.
 
 operator bool () const
 Return true if this object refers to a valid file.
 

Static Public Member Functions

static SDF_API SdfCrateInfo Open (std::string const &fileName)
 Attempt to open and read fileName.
 

Detailed Description

A class for introspecting the underlying qualities of .usdc 'crate' files, for diagnostic purposes.

Definition at line 28 of file crateInfo.h.

Member Function Documentation

◆ GetFileVersion()

SDF_API TfToken GetFileVersion ( ) const

Return the file version.

◆ GetSections()

SDF_API std::vector< Section > GetSections ( ) const

Return the named file sections, their location and sizes in the file.

◆ GetSoftwareVersion()

SDF_API TfToken GetSoftwareVersion ( ) const

Return the software version.

◆ GetSummaryStats()

SDF_API SummaryStats GetSummaryStats ( ) const

Return summary statistics structure for this file.

◆ Open()

static SDF_API SdfCrateInfo Open ( std::string const &  fileName)
static

Attempt to open and read fileName.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Return true if this object refers to a valid file.

Definition at line 69 of file crateInfo.h.

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