HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Hd_SortedIds Class Reference

#include <sortedIds.h>

Public Member Functions

HD_API Hd_SortedIds ()
 Default ctor produces an empty container. More...
 
HD_API ~Hd_SortedIds ()
 
HD_API Hd_SortedIds (Hd_SortedIds const &)
 Copy construct. More...
 
HD_API Hd_SortedIds (Hd_SortedIds &&)
 Move construct. More...
 
HD_API Hd_SortedIdsoperator= (Hd_SortedIds const &)
 Copy assign. More...
 
HD_API Hd_SortedIdsoperator= (Hd_SortedIds &&)
 Move assign. More...
 
HD_API const SdfPathVectorGetIds ()
 Sorts the ids if needed and returns the sorted list of ids. More...
 
HD_API void Insert (const SdfPath &id)
 
HD_API void Remove (const SdfPath &id)
 
HD_API void RemoveRange (size_t start, size_t end)
 
HD_API void Clear ()
 Removes all ids from the collection. More...
 

Detailed Description

Manages a container of Hydra Ids in a sorted order.

Note that this class behaves like a multiset. Duplicate elements are allowed.

Definition at line 25 of file sortedIds.h.

Constructor & Destructor Documentation

HD_API Hd_SortedIds::Hd_SortedIds ( )

Default ctor produces an empty container.

HD_API Hd_SortedIds::~Hd_SortedIds ( )
HD_API Hd_SortedIds::Hd_SortedIds ( Hd_SortedIds const &  )

Copy construct.

HD_API Hd_SortedIds::Hd_SortedIds ( Hd_SortedIds &&  )

Move construct.

Member Function Documentation

HD_API void Hd_SortedIds::Clear ( )

Removes all ids from the collection.

HD_API const SdfPathVector& Hd_SortedIds::GetIds ( )

Sorts the ids if needed and returns the sorted list of ids.

HD_API void Hd_SortedIds::Insert ( const SdfPath id)

Add an id to the collection. If the id is already present in the collection, a duplicate id is added.

HD_API Hd_SortedIds& Hd_SortedIds::operator= ( Hd_SortedIds const &  )

Copy assign.

HD_API Hd_SortedIds& Hd_SortedIds::operator= ( Hd_SortedIds &&  )

Move assign.

HD_API void Hd_SortedIds::Remove ( const SdfPath id)

Remove up to one occurrence of id from the collection. If the id is not present, do nothing. Otherwise remove one copy of id.

HD_API void Hd_SortedIds::RemoveRange ( size_t  start,
size_t  end 
)

Remove a range of id from the collection. Range defined by position index in sorted list. end is inclusive.


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