Loading...
Searching...
No Matches
VdfOutputSpec Class Reference

A VdfOuptutSpec describes an output connector. More...

#include <outputSpec.h>

Public Member Functions

 TF_MALLOC_TAG_NEW ("Vdf", "new VdfOutputSpec")
 
VDF_API std::string GetTypeName () const
 Returns the name of this spec's type.
 
TfType GetType () const
 Returns the type of this spec.
 
const TfTokenGetName () const
 Returns the name of this connector.
 
VDF_API VdfVectorAllocateCache () const
 Allocate a new VdfVector with this spec's type.
 
VDF_API void ResizeCache (VdfVector *vector, const VdfMask::Bits &bits) const
 Resize an existing VdfVector to accomodate all the data set in the bits.
 
bool operator== (const VdfOutputSpec &rhs) const
 Returns true, if two output specs are equal.
 
bool operator!= (const VdfOutputSpec &rhs) const
 
VDF_API size_t GetHash () const
 Returns a hash for this instance.
 

Static Public Member Functions

template<typename T >
static VdfOutputSpecNew (const TfToken &name)
 
static VDF_API VdfOutputSpecNew (TfType type, const TfToken &name)
 

Friends

class VdfExecutionTypeRegistry
 

Detailed Description

A VdfOuptutSpec describes an output connector.

It stores typing information and the connector's name.

Definition at line 39 of file outputSpec.h.

Member Function Documentation

◆ AllocateCache()

VDF_API VdfVector * AllocateCache ( ) const

Allocate a new VdfVector with this spec's type.

◆ GetHash()

VDF_API size_t GetHash ( ) const

Returns a hash for this instance.

◆ GetName()

const TfToken & GetName ( ) const
inline

Returns the name of this connector.

Definition at line 63 of file outputSpec.h.

◆ GetType()

TfType GetType ( ) const
inline

Returns the type of this spec.

Definition at line 60 of file outputSpec.h.

◆ GetTypeName()

VDF_API std::string GetTypeName ( ) const

Returns the name of this spec's type.

◆ New()

static VdfOutputSpec * New ( const TfToken name)
inlinestatic

Definition at line 45 of file outputSpec.h.

◆ operator!=()

bool operator!= ( const VdfOutputSpec rhs) const
inline

Definition at line 78 of file outputSpec.h.

◆ operator==()

bool operator== ( const VdfOutputSpec rhs) const
inline

Returns true, if two output specs are equal.

Definition at line 75 of file outputSpec.h.

◆ ResizeCache()

VDF_API void ResizeCache ( VdfVector vector,
const VdfMask::Bits bits 
) const

Resize an existing VdfVector to accomodate all the data set in the bits.

Friends And Related Function Documentation

◆ VdfExecutionTypeRegistry

friend class VdfExecutionTypeRegistry
friend

Definition at line 116 of file outputSpec.h.


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