VdfInputSpecs Class Reference

VdfInputSpecs is a container for VdfInputSpec objects. More...

#include <connectorSpecs.h>

Inheritance diagram for VdfInputSpecs:

Public Member Functions
template<typename T >
VdfInputSpecs &	ReadConnector (const TfToken &inName, const TfToken &outName=VdfTokens->empty, bool prerequisite=false)
	Create a "Read" connector with the name inName and optionally associated with the output named outName.
template<typename T >
VdfInputSpecs &	ReadWriteConnector (const TfToken &inName, const TfToken &outName)
	Create a "Read/Write" connector with the name inName associated with the output named outName.
const VdfInputSpec *	GetInputSpec (int idx) const
	Returns connector spec at index idx.
VdfInputSpecs &	ReadConnector (const TfType &type, const TfToken &inName, const TfToken &outName=VdfTokens->empty, bool prerequisite=false)
	Non-templated version of ReadConnector(), the given type must be registered for runtime type dispatching.
VdfInputSpecs &	ReadWriteConnector (const TfType &type, const TfToken &inName, const TfToken &outName)
	Non-templated version of ReadWriteConnector(), the given type must be registered for runtime type dispatching.
VDF_API bool	operator== (const VdfInputSpecs &rhs) const
	Returns true if two InputSpecs are equal.
bool	operator!= (const VdfInputSpecs &rhs) const
Public Member Functions inherited from VdfConnectorSpecs< VdfInputSpec >
	VdfConnectorSpecs ()
	Constructor.
	VdfConnectorSpecs (const VdfConnectorSpecs< VdfInputSpec > &rhs)
	Copy constructor.
	VdfConnectorSpecs (VdfConnectorSpecs< VdfInputSpec > &&rhs)
	Move constructor.
VdfConnectorSpecs< VdfInputSpec > &	operator= (const VdfConnectorSpecs< VdfInputSpec > &rhs)
	Copy assignment operator.
VdfConnectorSpecs< VdfInputSpec > &	operator= (VdfConnectorSpecs< VdfInputSpec > &&rhs)
	Move assignment operator.
void	Append (const VdfConnectorSpecs< VdfInputSpec > &specs)
	Appends a set of specs to this one.
void	Reserve (size_t numSpecs)
	Allocates space for numSpecs connector specs, to avoid re-allocation when adding specs, when the number of specs is known ahead of time.
size_t	GetSize () const
	Returns number of connectors in this spec.
const_iterator	begin () const
	Returns a const_iterator to the beginning of the connectors.
const_iterator	end () const
	Returns a const_iterator to the end of the connectors.

Additional Inherited Members
Public Types inherited from VdfConnectorSpecs< VdfInputSpec >
using	const_iterator = typename _VectorType::const_iterator
	Iterator type.
Protected Member Functions inherited from VdfConnectorSpecs< VdfInputSpec >
	~VdfConnectorSpecs ()
	Destructor.
void	_ClearSpecs ()
	Clears list of specs.
const VdfInputSpec *	_GetConnectorSpec (int idx) const
	Returns connector spec at index idx.
void	_AddConnector (VdfInputSpec *cs)
	Adds a connector to our list.

Detailed Description

VdfInputSpecs is a container for VdfInputSpec objects.

These objects are used to describe inputs on a VdfNode.

Definition at line 157 of file connectorSpecs.h.

Member Function Documentation

GetInputSpec()

const VdfInputSpec * GetInputSpec ( int  idx ) const

inline

Returns connector spec at index idx.

Definition at line 191 of file connectorSpecs.h.

operator!=()

bool operator!= ( const VdfInputSpecs &  rhs ) const

inline

Definition at line 230 of file connectorSpecs.h.

operator==()

VDF_API bool operator==

(

const VdfInputSpecs &

rhs

)

const

Returns true if two InputSpecs are equal.

ReadConnector() [1/2]

VdfInputSpecs & ReadConnector ( const TfToken &  inName, const TfToken &  outName = VdfTokens->empty, bool  prerequisite = false  )

inline

Create a "Read" connector with the name inName and optionally associated with the output named outName.

A read connector that has an associated output, tells the system that the masks coming in from outName can be propogated to the input inName.

Definition at line 169 of file connectorSpecs.h.

ReadConnector() [2/2]

VdfInputSpecs & ReadConnector ( const TfType &  type, const TfToken &  inName, const TfToken &  outName = VdfTokens->empty, bool  prerequisite = false  )

inline

Non-templated version of ReadConnector(), the given type must be registered for runtime type dispatching.

Definition at line 199 of file connectorSpecs.h.

ReadWriteConnector() [1/2]

VdfInputSpecs & ReadWriteConnector ( const TfToken &  inName, const TfToken &  outName  )

inline

Create a "Read/Write" connector with the name inName associated with the output named outName.

Definition at line 182 of file connectorSpecs.h.

ReadWriteConnector() [2/2]

VdfInputSpecs & ReadWriteConnector ( const TfType &  type, const TfToken &  inName, const TfToken &  outName  )

inline

Non-templated version of ReadWriteConnector(), the given type must be registered for runtime type dispatching.

Definition at line 214 of file connectorSpecs.h.

---

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

• pxr/exec/vdf/connectorSpecs.h