HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
VdfInputVector< T > Class Template Referencefinal

#include <inputVector.h>

+ Inheritance diagram for VdfInputVector< T >:

Public Member Functions

 VdfInputVector (VdfNetwork *const network, size_t n)
 
void SetValue (const size_t index, const T &value)
 
void SetValue (const size_t index, T &&value)
 
bool IsValueEqual (const size_t index, const T &val) const
 
const TGetValue (const size_t index) const
 
- Public Member Functions inherited from Vdf_InputVectorBase
size_t GetSize () const
 
VDF_API void Compute (const VdfContext &context) const overridefinal
 
VDF_API size_t GetMemoryUsage () const overridefinal
 
- Public Member Functions inherited from VdfNode
 TF_MALLOC_TAG_NEW ("Vdf","new VdfNode")
 
VDF_API VdfNode (VdfNetwork *network, const VdfInputSpecs &inputSpecs, const VdfOutputSpecs &outputSpecs)
 
VdfId GetId () const
 
const VdfNetworkGetNetwork () const
 
VdfNetworkGetNetwork ()
 
template<typename TYPE >
bool IsA () const
 
VDF_API bool IsEqual (const VdfNode &rhs) const
 
const VdfInputSpecsGetInputSpecs () const
 
const VdfInputGetInput (const TfToken &inputName) const
 
VDF_API VdfInputGetInput (const TfToken &inputName)
 
const InputMapIterator GetInputsIterator () const
 
bool HasInputConnections () const
 
bool HasOutputConnections () const
 
VDF_API VdfConnectionVector GetInputConnections () const
 
VDF_API VdfConnectionVector GetOutputConnections () const
 
const VdfOutputSpecsGetOutputSpecs () const
 
const VdfOutputGetOutput (const TfToken &name) const
 
VDF_API VdfOutputGetOutput (const TfToken &name)
 
VDF_API VdfOutputGetOptionalOutput (const TfToken &name)
 
const VdfOutputGetOptionalOutput (const TfToken &name) const
 
const VdfOutputGetOutput () const
 
VDF_API VdfOutputGetOutput ()
 
const OutputMapIterator GetOutputsIterator () const
 
size_t GetNumOutputs () const
 
size_t GetNumInputs () const
 
VDF_API void SetDebugName (const std::string &name)
 
template<class F >
void SetDebugNameCallback (F &&f)
 
VDF_API void SetDebugNameCallback (VdfNodeDebugNameCallback &&callback)
 
VDF_API const std::string GetDebugName () const
 
virtual VDF_API bool IsSpeculationNode () const
 
virtual VDF_API
VdfRequiredInputsPredicate 
GetRequiredInputsPredicate (const VdfContext &context) const
 
VDF_API VdfMask ComputeOutputDependencyMask (const VdfConnection &inputConnection, const VdfMask &inputDependencyMask, const VdfOutput &output) const
 
VDF_API void ComputeOutputDependencyMasks (const VdfConnection &inputConnection, const VdfMask &inputDependencyMask, VdfMaskedOutputVector *outputDependencies) const
 
VDF_API VdfMask::Bits ComputeInputDependencyMask (const VdfMaskedOutput &maskedOutput, const VdfConnection &inputConnection) const
 
VDF_API VdfConnectionAndMaskVector ComputeInputDependencyMasks (const VdfMaskedOutput &maskedOutput, bool skipAssociatedInputs) const
 
VDF_API VdfConnectionAndMaskVector ComputeInputDependencyRequest (const VdfMaskedOutputVector &request) const
 

Protected Types

typedef VdfInputVector< TThis
 

Protected Member Functions

 ~VdfInputVector () override
 
bool _IsDerivedEqual (const VdfNode &rhs) const override
 
- Protected Member Functions inherited from Vdf_InputVectorBase
VDF_API Vdf_InputVectorBase (VdfNetwork *network, const VdfOutputSpecs &outputSpecs, VdfVector &&values)
 
VDF_API ~Vdf_InputVectorBase () override
 
- Protected Member Functions inherited from VdfNode
VDF_API VdfNode (VdfNetwork *network)
 
VDF_API void _AppendInputs (const VdfInputSpecs &inputSpecs, std::vector< VdfInput * > *resultingInputs=NULL)
 
VDF_API void _AppendOutputs (const VdfOutputSpecs &outputSpecs, std::vector< VdfOutput * > *resultingOutputs=NULL)
 
virtual VDF_API void _DidAddInputConnection (const VdfConnection *c, int atIndex)
 
virtual VDF_API void _WillRemoveInputConnection (const VdfConnection *c)
 
virtual VDF_API ~VdfNode ()
 
void _SetId (const VdfVersion version, const VdfIndex index)
 
virtual VDF_API VdfMask _ComputeOutputDependencyMask (const VdfConnection &inputConnection, const VdfMask &inputDependencyMask, const VdfOutput &output) const
 
virtual VDF_API bool _ComputeOutputDependencyMasks (const VdfConnection &inputConnection, const VdfMask &inputDependencyMask, VdfMaskedOutputVector *outputDependencies) const
 
virtual VDF_API
VdfConnectionAndMaskVector 
_ComputeInputDependencyRequest (const VdfMaskedOutputVector &request) const
 
virtual VDF_API VdfMask::Bits _ComputeInputDependencyMask (const VdfMaskedOutput &maskedOutput, const VdfConnection &inputConnection) const
 
virtual VDF_API
VdfConnectionAndMaskVector 
_ComputeInputDependencyMasks (const VdfMaskedOutput &maskedOutput, bool skipAssociatedInputs) const
 
virtual VDF_API const
VdfInputAndOutputSpecs
_AcquireInputAndOutputSpecsPointer (const VdfInputSpecs &inputSpecs, const VdfOutputSpecs &outputSpecs)
 
virtual VDF_API void _ReleaseInputAndOutputSpecsPointer (const VdfInputAndOutputSpecs *specs)
 
VDF_API void _InitializeInputAndOutputSpecs (const VdfInputAndOutputSpecs *specs)
 
VDF_API void _ClearInputAndOutputSpecsPointer ()
 
VDF_API void _ReplaceInputSpecs (const VdfInputSpecs &inputSpecs)
 

Additional Inherited Members

- Static Public Member Functions inherited from VdfNode
static VdfIndex GetIndexFromId (const VdfId id)
 
static VdfVersion GetVersionFromId (const VdfId id)
 
- Static Protected Member Functions inherited from VdfNode
template<typename BaseClassType , typename ClassType >
static size_t _GetMemoryUsage (const ClassType &c, size_t dynamicSize)
 
- Protected Attributes inherited from Vdf_InputVectorBase
VdfVector _values
 

Detailed Description

template<typename T>
class VdfInputVector< T >

Definition at line 67 of file inputVector.h.

Member Typedef Documentation

template<typename T>
typedef VdfInputVector<T> VdfInputVector< T >::This
protected

Definition at line 136 of file inputVector.h.

Constructor & Destructor Documentation

template<typename T>
VdfInputVector< T >::VdfInputVector ( VdfNetwork *const  network,
size_t  n 
)
inline

Creates an input vector with n elements.

Definition at line 73 of file inputVector.h.

template<typename T >
VdfInputVector< T >::~VdfInputVector ( )
overrideprotecteddefault

Member Function Documentation

template<typename T>
bool VdfInputVector< T >::_IsDerivedEqual ( const VdfNode rhs) const
inlineoverrideprotectedvirtual

Can be overridden by derived classes to facilitate equality comparision.

The default implementation will always return false. Note that all connector specs, etc. are already taken care of via VdfNode::IsEqual().

Reimplemented from VdfNode.

Definition at line 139 of file inputVector.h.

template<typename T>
const T* VdfInputVector< T >::GetValue ( const size_t  index) const
inline

Returns a pointer to the value at index. If index is out of range an error will be raised and a nullptr returned.

Definition at line 120 of file inputVector.h.

template<typename T>
bool VdfInputVector< T >::IsValueEqual ( const size_t  index,
const T val 
) const
inline

Returns true if the value stored at index is equal to val.

Definition at line 108 of file inputVector.h.

template<typename T>
void VdfInputVector< T >::SetValue ( const size_t  index,
const T value 
)
inline

Sets the value for the input stored at index to value.

Definition at line 84 of file inputVector.h.

template<typename T>
void VdfInputVector< T >::SetValue ( const size_t  index,
T &&  value 
)
inline

Moves value into the input vector at index.

Definition at line 96 of file inputVector.h.


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