HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Friends | List of all members
VdfNodeSet Class Reference

#include <nodeSet.h>

Public Types

typedef TfBits::View
< TfBits::AllSet >
::const_iterator 		iterator
 
typedef TfBits::View
< TfBits::AllSet >
::const_iterator 		const_iterator
 

Public Member Functions

 VdfNodeSet ()=default
 
bool IsEmpty () const
 
size_t GetSize () const
 
VDF_API void Clear ()
 
bool Contains (const VdfNode &node) const
 
bool Contains (const VdfIndex index) const
 
void Insert (const VdfNode &node)
 
VDF_API void Insert (const VdfNodeSet &rhs)
 
VDF_API bool Remove (const VdfNode &node)
 
const_iterator begin () const
 
const_iterator end () const
 

Friends

void swap (VdfNodeSet &lhs, VdfNodeSet &rhs)
 

Detailed Description

Class that efficiently stores a set of VdfNodes.

Uses node indices to identify nodes, for efficient storage.

Definition at line 25 of file nodeSet.h.

Member Typedef Documentation

typedef TfBits::View<TfBits::AllSet>::const_iterator VdfNodeSet::const_iterator

Definition at line 82 of file nodeSet.h.

typedef TfBits::View<TfBits::AllSet>::const_iterator VdfNodeSet::iterator

Iterator types.

Definition at line 81 of file nodeSet.h.

Constructor & Destructor Documentation

VdfNodeSet::VdfNodeSet ( )
default

Default constructor

Member Function Documentation

const_iterator VdfNodeSet::begin ( void  ) const
inline

Returns an iterator at the beginning of the iterable range.

Definition at line 86 of file nodeSet.h.

VDF_API void VdfNodeSet::Clear ( )

Clears the node set.

Note that unlike on STL containers, this method also reclaims memory.

bool VdfNodeSet::Contains ( const VdfNode &  node) const
inline

Returns true if node is in the set.

Definition at line 53 of file nodeSet.h.

bool VdfNodeSet::Contains ( const VdfIndex  index) const
inline

Returns true if the node with the given index is in the set.

Definition at line 59 of file nodeSet.h.

const_iterator VdfNodeSet::end ( void  ) const
inline

Returns an iterator at the end of the iterable range.

Definition at line 92 of file nodeSet.h.

size_t VdfNodeSet::GetSize ( ) const
inline

Get the number of elements contained in this set.

Definition at line 40 of file nodeSet.h.

void VdfNodeSet::Insert ( const VdfNode &  node)
inline

Inserts node into the set.

Definition at line 116 of file nodeSet.h.

VDF_API void VdfNodeSet::Insert ( const VdfNodeSet &  rhs)

Inserts another nodeSet into this set.

bool VdfNodeSet::IsEmpty ( ) const
inline

Is this set empty?

Definition at line 34 of file nodeSet.h.

VDF_API bool VdfNodeSet::Remove ( const VdfNode &  node)

Removes node from the set.

Returns true if node was contained in the set.

Friends And Related Function Documentation

void swap ( VdfNodeSet &  lhs,
VdfNodeSet &  rhs 
)
friend

Swaps two VdfNodeSet instances.

Definition at line 98 of file nodeSet.h.

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