The derived Ef_VectorKey type, which implements the methods for generating hashes and equality comparing Ef_VectorKeys with wrapped VdfVectors of type T. More...

#include <vectorKey.h>

Inheritance diagram for Ef_TypedVectorKey< T >:

Public Member Functions
	Ef_TypedVectorKey (const VdfVector &value)
	Constructor.

	Ef_TypedVectorKey (const Ef_TypedVectorKey &)=delete
	Non-copyable.

Ef_TypedVectorKey &	operator= (const Ef_TypedVectorKey &)=delete

virtual size_t	CreateHash () const
	Implementation of the method that generates a hash from the VdfVector holding data of type T.

virtual bool	IsEqual (const Ef_VectorKey &rhs) const
	Implementation of the method that equality compares two Ef_VectorKeys of type T.

Public Member Functions inherited from Ef_VectorKey
	Ef_VectorKey (const Ef_VectorKey &)=delete
	Non-copyable.

Ef_VectorKey &	operator= (const Ef_VectorKey &)=delete

virtual EF_API	~Ef_VectorKey ()
	Destructor.

const VdfVector &	GetValue () const
	Returns the wrapped VdfVector.

virtual size_t	CreateHash () const =0
	Generates a hash from the VdfVector.

virtual bool	IsEqual (const Ef_VectorKey &) const =0
	Equality compares this Ef_VectorKey with another one.

bool	operator== (const Ef_VectorKey &rhs) const
	Equality operator.

bool	operator!= (const Ef_VectorKey &rhs) const

Additional Inherited Members
Public Types inherited from Ef_VectorKey
using	StoredType = std::shared_ptr< Ef_VectorKey >
	The type which must be used to store Ef_VectorKeys, for example as keys in a hash map.

Protected Member Functions inherited from Ef_VectorKey
	Ef_VectorKey (const VdfVector &value)

Protected Attributes inherited from Ef_VectorKey
const VdfVector	_value

Detailed Description

template<typename T>
class Ef_TypedVectorKey< T >

The derived Ef_VectorKey type, which implements the methods for generating hashes and equality comparing Ef_VectorKeys with wrapped VdfVectors of type T.

Definition at line 125 of file vectorKey.h.

Constructor & Destructor Documentation

◆ Ef_TypedVectorKey() [1/2]

Ef_TypedVectorKey ( const VdfVector & value )

inlineexplicit

Constructor.

Definition at line 131 of file vectorKey.h.

◆ Ef_TypedVectorKey() [2/2]

Ef_TypedVectorKey ( const Ef_TypedVectorKey< T > & )

delete

Non-copyable.

Member Function Documentation

◆ CreateHash()

virtual size_t CreateHash ( ) const

inlinevirtual

Implementation of the method that generates a hash from the VdfVector holding data of type T.

Implements Ef_VectorKey.

Definition at line 143 of file vectorKey.h.

◆ IsEqual()

virtual bool IsEqual ( const Ef_VectorKey & rhs ) const

inlinevirtual

Implementation of the method that equality compares two Ef_VectorKeys of type T.

Note, that if two Ef_VectorKeys do not hold the same type T, they will be considered unequal by design.

Implements Ef_VectorKey.

Definition at line 158 of file vectorKey.h.

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

pxr/exec/ef/vectorKey.h

Public Member Functions