HPS.OptimizeMappingResultsIterator Class Reference
Inheritance diagram for HPS.OptimizeMappingResultsIterator:
HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.Key GetItem ()
 
bool GetMergedShellInfo (out HPS.ShellKey out_shell_key, out ulong out_vertex_offset, out ulong out_face_offset, out ulong out_edge_offset)
 
bool IsValid ()
 
void Next ()
 
override HPS.Type ObjectType ()
 
 OptimizeMappingResultsIterator ()
 
 OptimizeMappingResultsIterator (HPS.OptimizeMappingResultsIterator in_mapping_results_iterator)
 
override void Reset ()
 
void Set (HPS.OptimizeMappingResultsIterator in_mapping_results_iterator)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ OptimizeMappingResultsIterator() [1/2]

HPS.OptimizeMappingResultsIterator.OptimizeMappingResultsIterator ( )
inline

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

◆ OptimizeMappingResultsIterator() [2/2]

HPS.OptimizeMappingResultsIterator.OptimizeMappingResultsIterator ( HPS.OptimizeMappingResultsIterator  in_mapping_results_iterator)
inline

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_iteratorThe source of the copy.

Member Function Documentation

◆ GetItem()

HPS.Key HPS.OptimizeMappingResultsIterator.GetItem ( )
inline

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.

◆ GetMergedShellInfo()

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

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

Parameters
out_shell_keyThe post merge shell that this item is in.
out_vertex_offsetThe offset that the vertices from the item start in the post merge shell.
out_face_offsetThe offset that the faces from the item start in the post merge shell.
out_edge_offsetThe offset that the edges from the item start in the post merge shell.
Returns
True if the out params are valid

◆ IsValid()

bool HPS.OptimizeMappingResultsIterator.IsValid ( )
inline

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.

◆ Next()

void HPS.OptimizeMappingResultsIterator.Next ( )
inline

Advances the iterator to the next search result item

◆ ObjectType()

override HPS.Type HPS.OptimizeMappingResultsIterator.ObjectType ( )
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.

◆ Reset()

override void HPS.OptimizeMappingResultsIterator.Reset ( )
inlinevirtual

Resets iterator to the beginning of the associated search results.

Reimplemented from HPS.Object.

◆ Set()

void HPS.OptimizeMappingResultsIterator.Set ( HPS.OptimizeMappingResultsIterator  in_mapping_results_iterator)
inline

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_iteratorThe source of the copy.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.OptimizeMappingResultsIterator.cs