VdfRequest Class Reference

#include <request.h>

Classes
class	const_iterator
struct	Hash
class	IndexedView

Public Member Functions
VDF_API	VdfRequest ()
VDF_API	VdfRequest (const VdfMaskedOutput &output)
VDF_API	VdfRequest (const VdfMaskedOutputVector &vector)
VDF_API	VdfRequest (VdfMaskedOutputVector &&vector)
VDF_API	~VdfRequest ()
VDF_API bool	IsEmpty () const
VDF_API size_t	GetSize () const
VDF_API const VdfNetwork *	GetNetwork () const
VDF_API const_iterator	begin () const
VDF_API const_iterator	end () const
VDF_API void	Add (const const_iterator &iterator)
VDF_API void	Remove (const const_iterator &iterator)
VDF_API void	AddAll ()
VDF_API void	RemoveAll ()

Friends
bool	operator== (const VdfRequest &lhs, const VdfRequest &rhs)
bool	operator!= (const VdfRequest &lhs, const VdfRequest &rhs)

Detailed Description

Definition at line 30 of file request.h.

Constructor & Destructor Documentation

VDF_API VdfRequest::VdfRequest

(

)

Constructor for empty VdfRequest.

VDF_API VdfRequest::VdfRequest ( const VdfMaskedOutput &  output )

explicit

Convenience constructor for a VdfRequest with a singular output.

VDF_API VdfRequest::VdfRequest ( const VdfMaskedOutputVector &  vector )

explicit

Constructor from a vector. Automatically sorts and uniques the vector. NOTE : The sort does not distinguish between masked outputs that contain the same VdfOutput pointer.

VDF_API VdfRequest::VdfRequest ( VdfMaskedOutputVector &&  vector )

explicit

Move constructor from a vector. Automatically sorts and uniques the vector. NOTE : The sort does not distinguish between masked outputs that contain the same VdfOutput pointer.

VDF_API VdfRequest::~VdfRequest

(

)

Destructor.

Member Function Documentation

VDF_API void VdfRequest::Add

(

const const_iterator &

iterator

)

Marks the element at the index of the VdfMaskedOutput that iterator points to as added.

VDF_API void VdfRequest::AddAll

(

)

Marks all the elements in the request as being "added". The bit set should be empty.

VDF_API const_iterator VdfRequest::begin

(

)

const

Returns a vector iterator to the beginning of the internally held vector.

VDF_API const_iterator VdfRequest::end

(

)

const

Returns a vector iterator to the end of the internally held vector.

VDF_API const VdfNetwork* VdfRequest::GetNetwork

(

)

const

Returns the network pointer of the first masked output. It assumes that all the masked outputs are from the same network. If the request is empty, returns NULL.

VDF_API size_t VdfRequest::GetSize

(

)

const

Returns the size of the internally held vector.

VDF_API bool VdfRequest::IsEmpty

(

)

const

Returns true if the size of the vector is 0.

VDF_API void VdfRequest::Remove

(

const const_iterator &

iterator

)

Marks the element at the index of the VdfMaskedOutput that iterator points to as removed.

VDF_API void VdfRequest::RemoveAll

(

)

Marks all the elements in the request as being "removed". The bit set should be the same size as the length of the vector, but all the bits should be unset.

Friends And Related Function Documentation

bool operator!= ( const VdfRequest &  lhs, const VdfRequest &  rhs  )

friend

Returns false if the internally held vector is the same, either by pointing to the same vector or by containing the same contents.

Definition at line 234 of file request.h.

bool operator== ( const VdfRequest &  lhs, const VdfRequest &  rhs  )

friend

Returns true if the internally held vector is the same, either by pointing to the same vector or by containing the same contents.

Definition at line 224 of file request.h.

---

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

• pxr/exec/vdf/request.h