Public Member Functions | Protected Member Functions | List of all members
HPS.STL.ImportNotifier Class Reference

The ImportNotifier 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. More...

Inheritance diagram for HPS.STL.ImportNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

override void Dispose ()
 
 ImportNotifier ()
 The default constructor creates an ImportNotifier object which is not tied to any file import. More...
 
 ImportNotifier (HPS.STL.ImportNotifier in_that)
 The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier. More...
 
 ImportNotifier (HPS.IONotifier in_that)
 The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Assign (HPS.STL.ImportNotifier in_that)
 Associate this ImportNotifier with the same file import as the source ImportNotifier. More...
 
HPS.STL.ImportResultsKit GetResults ()
 Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful. More...
 
- Public Member Functions inherited from HPS.IONotifier
 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...
 
void Assign (HPS.IONotifier in_that)
 Associate this IONotifier with the same file import as the source IONotifier. More...
 
void Wait ()
 Cause this thread to sleep until the file import this notifier is tied to has been handled. 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 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. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. 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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The ImportNotifier 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.STL.ImportNotifier.ImportNotifier ( )
inline

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

HPS.STL.ImportNotifier.ImportNotifier ( HPS.STL.ImportNotifier  in_that)
inline

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy.
HPS.STL.ImportNotifier.ImportNotifier ( HPS.IONotifier  in_that)
inline

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_notifier" kindref="compound">ImportNotifier</ref> to copy.

Member Function Documentation

void HPS.STL.ImportNotifier.Assign ( HPS.STL.ImportNotifier  in_that)
inline

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_notifier" kindref="compound">ImportNotifier</ref> for the assignment.
HPS.STL.ImportResultsKit HPS.STL.ImportNotifier.GetResults ( )
inline

Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.

Returns
The ImportResultsKit for a successful file import.
override HPS.Type HPS.STL.ImportNotifier.ObjectType ( )
inlinevirtual

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


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