VdfSchedule::OutputId Class Reference

An OutputId is a small key object that, once obtained for a particular VdfOutput, can be used to query the schedule about that VdfOutput. More...

#include <schedule.h>

Public Member Functions
bool	IsValid () const
	Returns whether this OutputId can be used to make queries about an output's scheduling.
OutputId &	operator++ ()
	Increment this OutputId to refer to the next scheduled output on the current output's node.
bool	operator== (const OutputId &rhs) const
	Equality operator.
bool	operator!= (const OutputId &rhs) const

Friends
class	VdfSchedule

Detailed Description

An OutputId is a small key object that, once obtained for a particular VdfOutput, can be used to query the schedule about that VdfOutput.

Querying the schedule using OutputId allows efficient queries to be made without specific knowledge of how the schedule stores its data.

Definition at line 91 of file schedule.h.

Member Function Documentation

IsValid()

bool IsValid ( ) const

inline

Returns whether this OutputId can be used to make queries about an output's scheduling.

Output which are not scheduled will have invalid ids.

Definition at line 97 of file schedule.h.

operator!=()

bool operator!= ( const OutputId &  rhs ) const

inline

Definition at line 120 of file schedule.h.

operator++()

OutputId & operator++ ( )

inline

Increment this OutputId to refer to the next scheduled output on the current output's node.

Callers should not expect an OutputId that is incremented past the end of the scheduled outputs to automatically go invalid. Rather than using this operator directly, consider using VDF_FOR_EACH_SCHEDULED_OUTPUT_ID(...) instead.

Definition at line 108 of file schedule.h.

operator==()

bool operator== ( const OutputId &  rhs ) const

inline

Equality operator.

Definition at line 115 of file schedule.h.

Friends And Related Function Documentation

VdfSchedule

friend class VdfSchedule

friend

Definition at line 144 of file schedule.h.

---

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

• pxr/exec/vdf/schedule.h