EfInputValueBlock Class Reference

An input value block is a vector of (output, value) pairs, each of which will be used to initialize a network before execution. More...

#include <inputValueBlock.h>

Public Types
typedef _VectorType::const_iterator	const_iterator
	A const iterator into a block vector.

Public Member Functions
	EfInputValueBlock ()=default
	Constructs an empty input value block.
EF_API	EfInputValueBlock (const EfInputValueBlock &rhs)
	Copy constructor.
	EfInputValueBlock (EfInputValueBlock &&rhs)=default
	Move constructor.
EF_API	~EfInputValueBlock ()
	Destructor.
EF_API EfInputValueBlock &	operator= (const EfInputValueBlock &rhs)
	Copy assignment operator.
EfInputValueBlock &	operator= (EfInputValueBlock &&rhs)=default
	Move assignment operator.
template<typename T >
void	AddOutputValuePair (const VdfMaskedOutput &output, const T &value)
	Adds an (output, value) pair to this block.
void	AddOutputVectorPair (const VdfMaskedOutput &output, const VdfVector &value)
	Adds an (output, VdfVector) pair to this block.
EF_API void	Apply (VdfExecutorInterface *executor, VdfMaskedOutputVector *invalidationRequest=NULL) const
	Applies the input value block to an executor, by setting the output values and pushing through invalidation for each one of the output values set.
EF_API void	InvalidateAndApply (VdfExecutorInterface *executor, const VdfMaskedOutputVector &invalidationRequest) const
	Pushes invalidation into the executor using the supplied invalidationRequest.
const_iterator	begin () const
	Returns a const_iterator to the beginning of the values vector.
const_iterator	end () const
	Returns a const_iterator to the end of the values vector.
size_t	GetSize () const
	Returns the number of outputs in this block.

Detailed Description

An input value block is a vector of (output, value) pairs, each of which will be used to initialize a network before execution.

Definition at line 35 of file inputValueBlock.h.

Member Typedef Documentation

const_iterator

typedef _VectorType::const_iterator const_iterator

A const iterator into a block vector.

Definition at line 114 of file inputValueBlock.h.

Constructor & Destructor Documentation

EfInputValueBlock() [1/3]

EfInputValueBlock ( )

default

Constructs an empty input value block.

EfInputValueBlock() [2/3]

EF_API EfInputValueBlock

(

const EfInputValueBlock &

rhs

)

Copy constructor.

EfInputValueBlock() [3/3]

EfInputValueBlock ( EfInputValueBlock &&  rhs )

default

Move constructor.

~EfInputValueBlock()

EF_API ~EfInputValueBlock

(

)

Destructor.

Member Function Documentation

AddOutputValuePair()

void AddOutputValuePair ( const VdfMaskedOutput &  output, const T &  value  )

inline

Adds an (output, value) pair to this block.

Note that this API currently only supports single valued outputs and does not yet support vectorized outputs.

Definition at line 78 of file inputValueBlock.h.

AddOutputVectorPair()

void AddOutputVectorPair ( const VdfMaskedOutput &  output, const VdfVector &  value  )

inline

Adds an (output, VdfVector) pair to this block.

Definition at line 86 of file inputValueBlock.h.

Apply()

EF_API void Apply	(	VdfExecutorInterface *	executor,
		VdfMaskedOutputVector *	invalidationRequest = NULL
	)		const

Applies the input value block to an executor, by setting the output values and pushing through invalidation for each one of the output values set.

invalidationRequest is an output parameter, which will return the request used for invalidation.

begin()

const_iterator begin ( ) const

inline

Returns a const_iterator to the beginning of the values vector.

Definition at line 118 of file inputValueBlock.h.

end()

const_iterator end ( ) const

inline

Returns a const_iterator to the end of the values vector.

Definition at line 124 of file inputValueBlock.h.

GetSize()

size_t GetSize ( ) const

inline

Returns the number of outputs in this block.

Definition at line 130 of file inputValueBlock.h.

InvalidateAndApply()

EF_API void InvalidateAndApply	(	VdfExecutorInterface *	executor,
		const VdfMaskedOutputVector &	invalidationRequest
	)		const

Pushes invalidation into the executor using the supplied invalidationRequest.

Contrary to the Apply method, this method does not infer the invalidation request from the set input values. Instead, the invalidationRequest may be specified by the caller.

operator=() [1/2]

EF_API EfInputValueBlock & operator=

(

const EfInputValueBlock &

rhs

)

Copy assignment operator.

operator=() [2/2]

EfInputValueBlock & operator= ( EfInputValueBlock &&  rhs )

default

Move assignment operator.

---

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

• pxr/exec/ef/inputValueBlock.h