#include <inputSpec.h>

Public Types
enum	Access { READ = 0x1, READWRITE = 0x2 }
	Access limits the kinds of operations allowed on the connector. More...

Public Member Functions
	TF_MALLOC_TAG_NEW ("Vdf","new VdfInputSpec")

VDF_API	~VdfInputSpec ()

TfType	GetType () const
	Returns the type of this spec. More...

const TfToken &	GetName () const
	Returns the name of this connector. More...

VDF_API std::string	GetTypeName () const
	Returns the name of this spec's type. More...

const Access &	GetAccess () const
	Returns the access of this connector. More...

VDF_API bool	TypeMatches (const VdfOutputSpec &other) const

const TfToken &	GetAssociatedOutputName () const

bool	IsPrerequisite () const

VDF_API size_t	GetHash () const
	Returns a hash for this instance. More...

bool	operator== (const VdfInputSpec &rhs) const

bool	operator!= (const VdfInputSpec &rhs) const

Static Public Member Functions
template<typename T >
static VdfInputSpec *	New (const TfToken &inName, const TfToken &outName, Access access, bool prerequisite)

static VdfInputSpec *	New (TfType type, const TfToken &inName, const TfToken &outName, Access access, bool prerequisite)

Detailed Description

A VdfInputSpec describes an input connector. It stores typing information, access information and the connector's name.

Definition at line 29 of file inputSpec.h.

Member Enumeration Documentation

enum VdfInputSpec::Access

Access limits the kinds of operations allowed on the connector.

Enumerator
READ
READWRITE

Definition at line 35 of file inputSpec.h.

Constructor & Destructor Documentation

VDF_API VdfInputSpec::~VdfInputSpec ( )

Member Function Documentation

const Access& VdfInputSpec::GetAccess ( ) const

inline

Returns the access of this connector.

Definition at line 75 of file inputSpec.h.

const TfToken& VdfInputSpec::GetAssociatedOutputName ( ) const

inline

Returns the name of the associated output, if any. If not set, returns the empty token.

Definition at line 85 of file inputSpec.h.

VDF_API size_t VdfInputSpec::GetHash ( ) const

Returns a hash for this instance.

const TfToken& VdfInputSpec::GetName ( ) const

inline

Returns the name of this connector.

Definition at line 68 of file inputSpec.h.

TfType VdfInputSpec::GetType ( ) const

inline

Returns the type of this spec.

Definition at line 65 of file inputSpec.h.

VDF_API std::string VdfInputSpec::GetTypeName ( ) const

Returns the name of this spec's type.

bool VdfInputSpec::IsPrerequisite ( ) const

inline

Returns whether or not this connector is a prerequisite connector.

Prerequisite outputs are the only ones that can be accessed by VdfNode::GetRequiredReadsIterator(VdfContext). Once these have been computed, a node provides dynamic input dependency information via that method.

Definition at line 96 of file inputSpec.h.

template<typename T >

static VdfInputSpec* VdfInputSpec::New	(	const TfToken &	inName,
		const TfToken &	outName,
		Access	access,
		bool	prerequisite
	)

inlinestatic

Definition at line 41 of file inputSpec.h.

static VdfInputSpec* VdfInputSpec::New	(	TfType	type,
		const TfToken &	inName,
		const TfToken &	outName,
		Access	access,
		bool	prerequisite
	)

inlinestatic

Definition at line 51 of file inputSpec.h.

bool VdfInputSpec::operator!= ( const VdfInputSpec & rhs ) const

inline

Definition at line 111 of file inputSpec.h.

bool VdfInputSpec::operator== ( const VdfInputSpec & rhs ) const

inline

Returns true, if two input specs are equal.

Definition at line 104 of file inputSpec.h.

VdfInputSpec::TF_MALLOC_TAG_NEW	(	"Vdf"	,
		"new VdfInputSpec"
	)

VDF_API bool VdfInputSpec::TypeMatches ( const VdfOutputSpec & other ) const

Returns true if this connector spec and other have the same type and false otherwise.

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

pxr/exec/vdf/inputSpec.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation