#include <output.h>

Public Member Functions
VDF_API	VdfOutput (VdfNode &owner, int specIndex)

VDF_API	~VdfOutput ()

const VdfConnectionVector &	GetConnections () const

size_t	GetNumConnections () const

const VdfNode &	GetNode () const

VdfNode &	GetNode ()

VDF_API const TfToken &	GetName () const

VDF_API void	SetAssociatedInput (const VdfInput *input)

const VdfInput *	GetAssociatedInput () const

const VdfMask *	GetAffectsMask () const

VDF_API void	SetAffectsMask (const VdfMask &mask)

VdfId	GetId () const

VDF_API const VdfOutputSpec &	GetSpec () const

VDF_API std::string	GetDebugName () const

VDF_API int	GetNumDataEntries () const

Static Public Member Functions
static VdfIndex	GetIndexFromId (const VdfId id)

static VdfVersion	GetVersionFromId (const VdfId 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

VDF_API VdfOutput::VdfOutput	(	VdfNode &	owner,
		int	specIndex
	)

Constructor

VDF_API VdfOutput::~VdfOutput ( )

Destructor

Member Function Documentation

const VdfMask* VdfOutput::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.

const VdfInput* VdfOutput::GetAssociatedInput ( ) const

inline

Returns the in/out connector associated with this output.

Definition at line 76 of file output.h.

const VdfConnectionVector& VdfOutput::GetConnections ( ) const

inline

Returns a list of connections connected to this output.

Definition at line 47 of file output.h.

VDF_API std::string VdfOutput::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.

VdfId VdfOutput::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.

static VdfIndex VdfOutput::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.

VDF_API const TfToken& VdfOutput::GetName ( ) const

Returns the name of this output.

const VdfNode& VdfOutput::GetNode ( ) const

inline

Returns the owning node for this output.

Definition at line 57 of file output.h.

VdfNode& VdfOutput::GetNode ( )

inline

Returns the non-const owning node for this output.

Definition at line 61 of file output.h.

size_t VdfOutput::GetNumConnections ( ) const

inline

Returns the number of connections for this output.

Definition at line 51 of file output.h.

VDF_API int VdfOutput::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.

VDF_API const VdfOutputSpec& VdfOutput::GetSpec ( ) const

Returns the connector specification object for this output.

static VdfVersion VdfOutput::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.

VDF_API void VdfOutput::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.

VDF_API void VdfOutput::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

friend class VdfIsolatedSubnetwork

friend

Definition at line 149 of file output.h.

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

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation