HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdCrateInfo Class Reference

#include <crateInfo.h>

Classes

struct  Section
 
struct  SummaryStats
 

Public Member Functions

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

Static Public Member Functions

static USD_API UsdCrateInfo Open (std::string const &fileName)
 Attempt to open and read fileName. More...
 

Detailed Description

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

Definition at line 45 of file crateInfo.h.

Member Function Documentation

USD_API TfToken UsdCrateInfo::GetFileVersion ( ) const

Return the file version.

USD_API std::vector<Section> UsdCrateInfo::GetSections ( ) const

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

USD_API TfToken UsdCrateInfo::GetSoftwareVersion ( ) const

Return the software version.

USD_API SummaryStats UsdCrateInfo::GetSummaryStats ( ) const

Return summary statistics structure for this file.

static USD_API UsdCrateInfo UsdCrateInfo::Open ( std::string const fileName)
static

Attempt to open and read fileName.

UsdCrateInfo::operator bool ( ) const
inlineexplicit

Return true if this object refers to a valid file.

Definition at line 86 of file crateInfo.h.


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