VdfConnection Class Reference

A class that fully represents a connection between two VdfNodes. More...

#include <connection.h>

Public Member Functions
	VdfConnection (VdfOutput &output, const VdfMask &mask, VdfInput &input)
const VdfNode &	GetSourceNode () const
	Returns the source (ie. output) node for this connection.
VdfNode &	GetSourceNode ()
	Returns the source (ie. output) node for this connection.
const VdfNode &	GetTargetNode () const
	Returns the target (ie. input) node for this connection.
VdfNode &	GetTargetNode ()
	Returns the target (ie. input) node for this connection.
const VdfOutput &	GetSourceOutput () const
	Returns the output (ie. source) for this connection.
VdfOutput &	GetSourceOutput ()
	Returns the output (ie. source) for this connection.
VdfOutput &	GetNonConstSourceOutput () const
	Returns the output (ie. source) for this connection.
VdfMaskedOutput	GetSourceMaskedOutput () const
	Return the masked output (ie. source) for this connection.
const VdfInput &	GetTargetInput () const
	Returns the input connector (ie. target) for this connection.
VdfInput &	GetTargetInput ()
	Returns the input connector (ie. target) for this connection.
const VdfMask &	GetMask () const
	Returns the mask for this connection.
VDF_API std::string	GetDebugName () const
	Returns a debug string for this connection.

Detailed Description

A class that fully represents a connection between two VdfNodes.

Definition at line 29 of file connection.h.

Constructor & Destructor Documentation

VdfConnection()

VdfConnection ( VdfOutput &  output, const VdfMask &  mask, VdfInput &  input  )

inline

Definition at line 33 of file connection.h.

Member Function Documentation

GetDebugName()

VDF_API std::string GetDebugName

(

)

const

Returns a debug string for this connection.

GetMask()

const VdfMask & GetMask ( ) const

inline

Returns the mask for this connection.

Definition at line 99 of file connection.h.

GetNonConstSourceOutput()

VdfOutput & GetNonConstSourceOutput ( ) const

inline

Returns the output (ie. source) for this connection.

Definition at line 76 of file connection.h.

GetSourceMaskedOutput()

VdfMaskedOutput GetSourceMaskedOutput ( ) const

inline

Return the masked output (ie. source) for this connection.

Definition at line 82 of file connection.h.

GetSourceNode() [1/2]

VdfNode & GetSourceNode ( )

inline

Returns the source (ie. output) node for this connection.

Definition at line 45 of file connection.h.

GetSourceNode() [2/2]

const VdfNode & GetSourceNode ( ) const

inline

Returns the source (ie. output) node for this connection.

Definition at line 39 of file connection.h.

GetSourceOutput() [1/2]

VdfOutput & GetSourceOutput ( )

inline

Returns the output (ie. source) for this connection.

Definition at line 69 of file connection.h.

GetSourceOutput() [2/2]

const VdfOutput & GetSourceOutput ( ) const

inline

Returns the output (ie. source) for this connection.

Definition at line 63 of file connection.h.

GetTargetInput() [1/2]

VdfInput & GetTargetInput ( )

inline

Returns the input connector (ie. target) for this connection.

Definition at line 93 of file connection.h.

GetTargetInput() [2/2]

const VdfInput & GetTargetInput ( ) const

inline

Returns the input connector (ie. target) for this connection.

Definition at line 87 of file connection.h.

GetTargetNode() [1/2]

VdfNode & GetTargetNode ( )

inline

Returns the target (ie. input) node for this connection.

Definition at line 57 of file connection.h.

GetTargetNode() [2/2]

const VdfNode & GetTargetNode ( ) const

inline

Returns the target (ie. input) node for this connection.

Definition at line 51 of file connection.h.

---

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

• pxr/exec/vdf/connection.h