< Home

< Table of Contents

REFERENCE MANUAL

HPS.IONotifier Class Reference

The IONotifier class is a smart-pointer that is tied to a file import. More...

Inheritance diagram for HPS.IONotifier:
HPS.Object HPS.Exchange.ImportNotifier HPS.Exchange.TranslationNotifier HPS.OBJ.ImportNotifier HPS.Parasolid.ImportNotifier HPS.Sketchup.ImportNotifier HPS.STL.ImportNotifier HPS.Stream.ImportNotifier

Public Member Functions

void Assign (HPS.IONotifier in_that)
 Associate this IONotifier with the same file import as the source IONotifier. More...
 
void Cancel ()
 Cancels the import if it is still in progress. More...
 
override void Dispose ()
 
 IONotifier ()
 The default constructor creates an IONotifier object which is not tied to any file import. More...
 
 IONotifier (HPS.IONotifier in_that)
 The copy constructor creates a new IONotifier object that is associated with the same file import as the source IONotifier. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.IOResult Status ()
 Query the status of the file import this notifier is tied to. More...
 
HPS.IOResult Status (out float out_percent_complete)
 Query the status of the file import this notifier is tied to and its percentage complete. More...
 
void Wait ()
 Cause this thread to sleep until the file import this notifier is tied to has been handled. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

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
 
HandleRef scptr
 

Detailed Description

The IONotifier class is a smart-pointer that is tied to a file import.

It is used to interact with an ongoing import or get the results from a completed import.

Constructor & Destructor Documentation

HPS.IONotifier.IONotifier ( )

The default constructor creates an IONotifier object which is not tied to any file import.

HPS.IONotifier.IONotifier ( HPS.IONotifier  in_that)

The copy constructor creates a new IONotifier object that is associated with the same file import as the source IONotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_i_o_notifier" kindref="compound">IONotifier</ref> to copy.

Member Function Documentation

void HPS.IONotifier.Assign ( HPS.IONotifier  in_that)

Associate this IONotifier with the same file import as the source IONotifier.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_i_o_notifier" kindref="compound">IONotifier</ref> for the assignment.
void HPS.IONotifier.Cancel ( )

Cancels the import if it is still in progress.

There may be some delay between when the cancel request is made and when the import stops and any associated data is deleted as the importer checks for a cancel request periodically during import.

override HPS.Type HPS.IONotifier.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

Reimplemented in HPS.Parasolid.ImportNotifier, HPS.Exchange.ImportNotifier, HPS.Stream.ImportNotifier, HPS.Exchange.TranslationNotifier, HPS.OBJ.ImportNotifier, HPS.STL.ImportNotifier, and HPS.Sketchup.ImportNotifier.

HPS.IOResult HPS.IONotifier.Status ( )

Query the status of the file import this notifier is tied to.

Returns
The current state of the file import.
HPS.IOResult HPS.IONotifier.Status ( out float  out_percent_complete)

Query the status of the file import this notifier is tied to and its percentage complete.

Parameters
out_percent_complete<ref refid="class_h_p_s_1_1_float" kindref="compound">Float</ref> in the range [0,1] indicating the current percentage complete.
Returns
The current state of the file import.
void HPS.IONotifier.Wait ( )

Cause this thread to sleep until the file import this notifier is tied to has been handled.


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