#include <hps.h>

Public Member Functions | |
Key | GetItem () const |
bool | GetMergedShellInfo (ShellKey &out_shell_key, size_t &out_vertex_offset, size_t &out_face_offset, size_t &out_edge_offset) const |
bool | IsValid () const |
void | Next () |
HPS::Type | ObjectType () const |
bool | operator!= (OptimizeMappingResultsIterator const &in_mapping_results_iterator) |
Key | operator* () const |
OptimizeMappingResultsIterator & | operator++ () |
OptimizeMappingResultsIterator | operator++ (int in_val) |
OptimizeMappingResultsIterator & | operator= (OptimizeMappingResultsIterator &&in_that) |
OptimizeMappingResultsIterator & | operator= (OptimizeMappingResultsIterator const &in_mapping_results_iterator) |
bool | operator== (OptimizeMappingResultsIterator const &in_mapping_results_iterator) |
OptimizeMappingResultsIterator () | |
OptimizeMappingResultsIterator (OptimizeMappingResultsIterator const &in_mapping_results_iterator) | |
OptimizeMappingResultsIterator (OptimizeMappingResultsIterator &&in_that) | |
void | Reset () |
void | Set (OptimizeMappingResultsIterator const &in_mapping_results_iterator) |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::OptimizeMappingResultsIterator |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
An iterator used for traversing results from a optimize on an associated OptimizeMappingResults object.
Constructor & Destructor Documentation
HPS::OptimizeMappingResultsIterator::OptimizeMappingResultsIterator | ( | ) |
The default constructor creates a new OptimizeMappingResultsIterator object that is not associated with any OptimizeMappingResults object.
HPS::OptimizeMappingResultsIterator::OptimizeMappingResultsIterator | ( | OptimizeMappingResultsIterator const & | in_mapping_results_iterator | ) |
The copy constructor initializes a new OptimizeMappingResultsIterator object that is associated with the same OptimizeMappingResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.
- Parameters
-
in_mapping_results_iterator The source of the copy.
HPS::OptimizeMappingResultsIterator::OptimizeMappingResultsIterator | ( | OptimizeMappingResultsIterator && | in_that | ) |
The move constructor creates a OptimizeMappingResultsIterator by transferring the underlying impl of the rvalue reference to this OptimizeMappingResultsIterator thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to OptimizeMappingResultsIterator to take the impl from.
Member Function Documentation
Key HPS::OptimizeMappingResultsIterator::GetItem | ( | ) | const |
Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. This method is functionally equivalent to the overloaded operator*.
- Returns
- The current item.
bool HPS::OptimizeMappingResultsIterator::GetMergedShellInfo | ( | ShellKey & | out_shell_key, |
size_t & | out_vertex_offset, | ||
size_t & | out_face_offset, | ||
size_t & | out_edge_offset | ||
) | const |
Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.
- Parameters
-
out_shell_key The post merge shell that this item is in. out_vertex_offset The offset that the vertices from the item start in the post merge shell. out_face_offset The offset that the faces from the item start in the post merge shell. out_edge_offset The offset that the edges from the item start in the post merge shell.
- Returns
- True if the out params are valid
bool HPS::OptimizeMappingResultsIterator::IsValid | ( | ) | const |
Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
- Returns
- true if this iterator is pointing to a valid item, false otherwise.
void HPS::OptimizeMappingResultsIterator::Next | ( | ) |
Advances the iterator to the next search result item
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::OptimizeMappingResultsIterator::operator!= | ( | OptimizeMappingResultsIterator const & | in_mapping_results_iterator | ) |
Comparison operator between iterators to compare inequality
- Parameters
-
in_mapping_results_iterator The iterator to compare to
Key HPS::OptimizeMappingResultsIterator::operator* | ( | ) | const |
Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.
- Returns
- The current item.
OptimizeMappingResultsIterator& HPS::OptimizeMappingResultsIterator::operator++ | ( | ) |
Advances the iterator to the next search result item
- Returns
- A reference to this object.
OptimizeMappingResultsIterator HPS::OptimizeMappingResultsIterator::operator++ | ( | int | in_val | ) |
Advances the iterator to the next search result item
- Returns
- A reference to this object.
OptimizeMappingResultsIterator& HPS::OptimizeMappingResultsIterator::operator= | ( | OptimizeMappingResultsIterator && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this OptimizeMappingResultsIterator thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an OptimizeMappingResultsIterator to take the impl from.
- Returns
- A reference to this OptimizeMappingResultsIterator.
OptimizeMappingResultsIterator& HPS::OptimizeMappingResultsIterator::operator= | ( | OptimizeMappingResultsIterator const & | in_mapping_results_iterator | ) |
Copies a OptimizeMappingResultsIterator object, associating this object with the same OptimizeMappingResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.
- Parameters
-
in_mapping_results_iterator The source of the copy.
- Returns
- a reference to this object.
bool HPS::OptimizeMappingResultsIterator::operator== | ( | OptimizeMappingResultsIterator const & | in_mapping_results_iterator | ) |
Comparison operator between iterators to compare equality
- Parameters
-
in_mapping_results_iterator The iterator to compare to
|
virtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS::Object.
void HPS::OptimizeMappingResultsIterator::Set | ( | OptimizeMappingResultsIterator const & | in_mapping_results_iterator | ) |
Copies a OptimizeMappingResultsIterator object, associating this object with the same OptimizeMappingResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value.
- Parameters
-
in_mapping_results_iterator The source of the copy.
The documentation for this class was generated from the following file:
- include/hps.h