VdfOutputSpecs Class Reference

VdfOutputSpecs is a container for VdfOutputSpec objects. More...

#include <connectorSpecs.h>

Inheritance diagram for VdfOutputSpecs:

Public Member Functions
template<typename T >
VdfOutputSpecs &	Connector (const TfToken &name)
	Create an "Out" connector with the given name.
const VdfOutputSpec *	GetOutputSpec (int idx) const
	Returns connector spec at index idx.
VdfOutputSpecs &	Connector (const TfType &type, const TfToken &name)
	Non-templated version of Connector(), the given type must be registered for runtime type dispatching.
VDF_API bool	operator== (const VdfOutputSpecs &rhs) const
	Returns true if two OutputSpecs are equal.
bool	operator!= (const VdfOutputSpecs &rhs) const
Public Member Functions inherited from VdfConnectorSpecs< VdfOutputSpec >
	VdfConnectorSpecs ()
	Constructor.
	VdfConnectorSpecs (const VdfConnectorSpecs< VdfOutputSpec > &rhs)
	Copy constructor.
	VdfConnectorSpecs (VdfConnectorSpecs< VdfOutputSpec > &&rhs)
	Move constructor.
VdfConnectorSpecs< VdfOutputSpec > &	operator= (const VdfConnectorSpecs< VdfOutputSpec > &rhs)
	Copy assignment operator.
VdfConnectorSpecs< VdfOutputSpec > &	operator= (VdfConnectorSpecs< VdfOutputSpec > &&rhs)
	Move assignment operator.
void	Append (const VdfConnectorSpecs< VdfOutputSpec > &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< VdfOutputSpec >
using	const_iterator = typename _VectorType::const_iterator
	Iterator type.
Protected Member Functions inherited from VdfConnectorSpecs< VdfOutputSpec >
	~VdfConnectorSpecs ()
	Destructor.
void	_ClearSpecs ()
	Clears list of specs.
const VdfOutputSpec *	_GetConnectorSpec (int idx) const
	Returns connector spec at index idx.
void	_AddConnector (VdfOutputSpec *cs)
	Adds a connector to our list.

Detailed Description

VdfOutputSpecs is a container for VdfOutputSpec objects.

These objects are used to describe outputs on a VdfNode.

Definition at line 241 of file connectorSpecs.h.

Member Function Documentation

Connector() [1/2]

VdfOutputSpecs & Connector ( const TfToken &  name )

inline

Create an "Out" connector with the given name.

Definition at line 247 of file connectorSpecs.h.

Connector() [2/2]

VdfOutputSpecs & Connector ( const TfType &  type, const TfToken &  name  )

inline

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

Definition at line 262 of file connectorSpecs.h.

GetOutputSpec()

const VdfOutputSpec * GetOutputSpec ( int  idx ) const

inline

Returns connector spec at index idx.

Definition at line 254 of file connectorSpecs.h.

operator!=()

bool operator!= ( const VdfOutputSpecs &  rhs ) const

inline

Definition at line 272 of file connectorSpecs.h.

operator==()

VDF_API bool operator==

(

const VdfOutputSpecs &

rhs

)

const

Returns true if two OutputSpecs are equal.

---

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

• pxr/exec/vdf/connectorSpecs.h