VdfInput Class Reference

A VdfInput is used to connect a VdfNode to one or more VdfNodes' outputs. More...

#include <input.h>

Public Member Functions
VDF_API	~VdfInput ()
	Destructor.
	VdfInput (VdfNode &owner, int specIndex, const VdfOutput *output=NULL)
	Constructor.
const VdfConnectionVector &	GetConnections () const
	Returns a list of connections connected to this input.
size_t	GetNumConnections () const
	Returns the number of connections for this input.
const VdfConnection &	operator[] (size_t index) const
	Returns the connection at index.
VdfConnection &	GetNonConstConnection (size_t index) const
	Returns the connection at index, writable.
VDF_API const VdfInputSpec &	GetSpec () const
	Returns the spec for this input connector.
const VdfOutput *	GetAssociatedOutput () const
	Returns the output corresponding to this input.
const VdfNode &	GetNode () const
	Returns the owning node for this input connector.
VdfNode &	GetNode ()
	Returns the non-const owning node for this input connector.
const TfToken &	GetName () const
	Returns the name of this input.
VDF_API std::string	GetDebugName () const
	Returns a descriptive name for this input connector.

Friends
class	VdfNetwork
class	VdfIsolatedSubnetwork
class	VdfOutput

Detailed Description

A VdfInput is used to connect a VdfNode to one or more VdfNodes' outputs.

Each of the connections is represented by a VdfConnection object that is owned by the VdfInput.

Definition at line 35 of file input.h.

Constructor & Destructor Documentation

~VdfInput()

VDF_API ~VdfInput

(

)

Destructor.

VdfInput()

VdfInput ( VdfNode &  owner, int  specIndex, const VdfOutput *  output = NULL  )

inline

Constructor.

Creates an empty connector.

Definition at line 48 of file input.h.

Member Function Documentation

GetAssociatedOutput()

const VdfOutput * GetAssociatedOutput ( ) const

inline

Returns the output corresponding to this input.

This is only non-NULL for writeable input connectors.

Definition at line 82 of file input.h.

GetConnections()

const VdfConnectionVector & GetConnections ( ) const

inline

Returns a list of connections connected to this input.

Definition at line 54 of file input.h.

GetDebugName()

VDF_API std::string GetDebugName

(

)

const

Returns a descriptive name for this input connector.

GetName()

const TfToken & GetName ( ) const

inline

Returns the name of this input.

Definition at line 94 of file input.h.

GetNode() [1/2]

VdfNode & GetNode ( )

inline

Returns the non-const owning node for this input connector.

Definition at line 90 of file input.h.

GetNode() [2/2]

const VdfNode & GetNode ( ) const

inline

Returns the owning node for this input connector.

Definition at line 86 of file input.h.

GetNonConstConnection()

VdfConnection & GetNonConstConnection ( size_t  index ) const

inline

Returns the connection at index, writable.

Definition at line 70 of file input.h.

GetNumConnections()

size_t GetNumConnections ( ) const

inline

Returns the number of connections for this input.

Definition at line 58 of file input.h.

GetSpec()

VDF_API const VdfInputSpec & GetSpec

(

)

const

Returns the spec for this input connector.

operator[]()

const VdfConnection & operator[] ( size_t  index ) const

inline

Returns the connection at index.

Definition at line 64 of file input.h.

Friends And Related Function Documentation

VdfIsolatedSubnetwork

friend class VdfIsolatedSubnetwork

friend

Definition at line 108 of file input.h.

VdfNetwork

friend class VdfNetwork

friend

Definition at line 107 of file input.h.

VdfOutput

friend class VdfOutput

friend

Definition at line 111 of file input.h.

---

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

• pxr/exec/vdf/input.h