VdfOutput Class Reference

A VdfOutput represents an output on a node. More...

#include <output.h>

Public Member Functions
VDF_API	VdfOutput (VdfNode &owner, int specIndex)
	Constructor.
VDF_API	~VdfOutput ()
	Destructor.
const VdfConnectionVector &	GetConnections () const
	Returns a list of connections connected to this output.
size_t	GetNumConnections () const
	Returns the number of connections for this output.
const VdfNode &	GetNode () const
	Returns the owning node for this output.
VdfNode &	GetNode ()
	Returns the non-const owning node for this output.
VDF_API const TfToken &	GetName () const
	Returns the name of this output.
VDF_API void	SetAssociatedInput (const VdfInput *input)
	Sets the input associated with this output.
const VdfInput *	GetAssociatedInput () const
	Returns the in/out connector associated with this output.
const VdfMask *	GetAffectsMask () const
	Returns the mask of elements that this output is expected to modify from its corresponding input.
VDF_API void	SetAffectsMask (const VdfMask &mask)
	Sets the affects mask for this output.
VdfId	GetId () const
	The unique id of this output.
VDF_API const VdfOutputSpec &	GetSpec () const
	Returns the connector specification object for this output.
VDF_API std::string	GetDebugName () const
	Returns the debug name for this output.
VDF_API int	GetNumDataEntries () const
	Returns the expected number of entries in the data computed at this output.

Static Public Member Functions
static VdfIndex	GetIndexFromId (const VdfId id)
	Get the output index from the output id.
static VdfVersion	GetVersionFromId (const VdfId id)
	Get the output version from the output id.

Friends
class	VdfNetwork
class	VdfIsolatedSubnetwork

Detailed Description

A VdfOutput represents an output on a node.

It has a spec and a list of nodes currently connected to it.

Definition at line 31 of file output.h.

Constructor & Destructor Documentation

VdfOutput()

VDF_API VdfOutput	(	VdfNode &	owner,
		int	specIndex
	)

Constructor.

~VdfOutput()

VDF_API ~VdfOutput

(

)

Destructor.

Member Function Documentation

GetAffectsMask()

const VdfMask * GetAffectsMask ( ) const

inline

Returns the mask of elements that this output is expected to modify from its corresponding input.

Outputs with no corresponding input return a NULL mask.

Definition at line 85 of file output.h.

GetAssociatedInput()

const VdfInput * GetAssociatedInput ( ) const

inline

Returns the in/out connector associated with this output.

Definition at line 76 of file output.h.

GetConnections()

const VdfConnectionVector & GetConnections ( ) const

inline

Returns a list of connections connected to this output.

Definition at line 47 of file output.h.

GetDebugName()

VDF_API std::string GetDebugName

(

)

const

Returns the debug name for this output.

Creates a debug name that combines the output name with the debug name of its owner.

GetId()

VdfId GetId ( ) const

inline

The unique id of this output.

No current, or previously constructed output in the same network will share this id.

Definition at line 100 of file output.h.

GetIndexFromId()

static VdfIndex GetIndexFromId ( const VdfId  id )

inlinestatic

Get the output index from the output id.

The index uniquely identifies the output in the current state of the network, but may alias an index which existed in a previous state of the network and has since been destructed.

Definition at line 109 of file output.h.

GetName()

VDF_API const TfToken & GetName

(

)

const

Returns the name of this output.

GetNode() [1/2]

VdfNode & GetNode ( )

inline

Returns the non-const owning node for this output.

Definition at line 61 of file output.h.

GetNode() [2/2]

const VdfNode & GetNode ( ) const

inline

Returns the owning node for this output.

Definition at line 57 of file output.h.

GetNumConnections()

size_t GetNumConnections ( ) const

inline

Returns the number of connections for this output.

Definition at line 51 of file output.h.

GetNumDataEntries()

VDF_API int GetNumDataEntries

(

)

const

Returns the expected number of entries in the data computed at this output.

This number is a guess based on what's currently connected to the output.

GetSpec()

VDF_API const VdfOutputSpec & GetSpec

(

)

const

Returns the connector specification object for this output.

GetVersionFromId()

static VdfVersion GetVersionFromId ( const VdfId  id )

inlinestatic

Get the output version from the output id.

Output ids with the same index are disambiguated by a version number. Given multiple output ids with the same index, only one version will match the current state of the network.

Definition at line 118 of file output.h.

SetAffectsMask()

VDF_API void SetAffectsMask

(

const VdfMask &

mask

)

Sets the affects mask for this output.

It is a coding error to set this mask on an output that has no corresponding input, or to set a mask that is of size 0.

SetAssociatedInput()

VDF_API void SetAssociatedInput

(

const VdfInput *

input

)

Sets the input associated with this output.

If input is NULL it clears the associated input.

Friends And Related Function Documentation

VdfIsolatedSubnetwork

friend class VdfIsolatedSubnetwork

friend

Definition at line 149 of file output.h.

VdfNetwork

friend class VdfNetwork

friend

Definition at line 148 of file output.h.

---

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

• pxr/exec/vdf/output.h