HPS.OptimizeMappingResultsIterator

class HPS.OptimizeMappingResultsIterator : public HPS.Object

An iterator used for traversing results from a optimize on an associated OptimizeMappingResults object.

Public Functions

HPS.Key GetItem ()

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*.

Return

The current item.

bool GetMergedShellInfo (out HPS.ShellKey out_shell_key, out ulong out_vertex_offset, out ulong out_face_offset, out ulong out_edge_offset)

Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.

Param out_shell_key

The post merge shell that this item is in.

Param out_vertex_offset

The offset that the vertices from the item start in the post merge shell.

Param out_face_offset

The offset that the faces from the item start in the post merge shell.

Param out_edge_offset

The offset that the edges from the item start in the post merge shell.

Return

True if the out params are valid

bool IsValid ()

Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.

Return

true if this iterator is pointing to a valid item, false otherwise.

void Next ()

Advances the iterator to the next search result item

override HPS.Type ObjectType ()

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).

Return

The declared type of the object in question, which may differ from the true, underlying type.

OptimizeMappingResultsIterator ()

The default constructor creates a new OptimizeMappingResultsIterator object that is not associated with any OptimizeMappingResults object.

OptimizeMappingResultsIterator (HPS.OptimizeMappingResultsIterator 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.

Param in_mapping_results_iterator

The source of the copy.

override void Reset ()

Resets iterator to the beginning of the associated search results.

void Set (HPS.OptimizeMappingResultsIterator 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.

Param in_mapping_results_iterator

The source of the copy.