HdDataSharingSchema Class Reference

#include <dataSharingSchema.h>

Inheritance diagram for HdDataSharingSchema:

Classes
class	SharingId

Public Types
using	SharingIdDataSource = HdTypedSampledDataSource< SharingId >
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource

Public Member Functions
HD_API SdfPath	GetSharingId () const
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (size_t count, const TfToken *names, const HdDataSourceBaseHandle *values)

Schema retrieval
	HdDataSharingSchema (HdContainerDataSourceHandle container)
static HD_API HdDataSharingSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 47 of file dataSharingSchema.h.

Member Typedef Documentation

using HdDataSharingSchema::SharingIdDataSource = HdTypedSampledDataSource<SharingId>

Definition at line 91 of file dataSharingSchema.h.

Constructor & Destructor Documentation

HdDataSharingSchema::HdDataSharingSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "dataSharing" from the parent container and constructs a HdDataSharingSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 53 of file dataSharingSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdDataSharingSchema::BuildRetained ( size_t  count, const TfToken *  names, const HdDataSourceBaseHandle *  values  )

static

static HD_API HdDataSharingSchema HdDataSharingSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "dataSharing" from the parent container and constructs a HdDataSharingSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

static HD_API const TfToken& HdDataSharingSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

HD_API SdfPath HdDataSharingSchema::GetSharingId

(

)

const

Extracts SdfPath from container that was added via SharingIdDataSource.

---

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

• pxr/imaging/hd/dataSharingSchema.h