HPS.HCA.ImportNotifier Class Reference
Inheritance diagram for HPS.HCA.ImportNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

void Assign (HPS.HCA.ImportNotifier in_that)
override void Dispose ()
HPS.Model GetTarget ()
 ImportNotifier ()
 ImportNotifier (HPS.HCA.ImportNotifier in_that)
 ImportNotifier (HPS.IONotifier in_that)
override HPS.Type ObjectType ()
- Public Member Functions inherited from HPS.IONotifier
void Assign (HPS.IONotifier in_that)
HPS.IONotifier Cancel ()
 IONotifier ()
 IONotifier (HPS.IONotifier in_that)
HPS.IOResult Status ()
HPS.IOResult Status (out float out_percent_complete)
HPS.IONotifier Wait ()
- 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 void Reset ()
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

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

◆ ImportNotifier() [1/3]

HPS.HCA.ImportNotifier.ImportNotifier ( )

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

◆ ImportNotifier() [2/3]

HPS.HCA.ImportNotifier.ImportNotifier ( HPS.HCA.ImportNotifier  in_that)

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

in_thatThe source ImportNotifier to copy.

◆ ImportNotifier() [3/3]

HPS.HCA.ImportNotifier.ImportNotifier ( HPS.IONotifier  in_that)

The conversion constructor creates a new derived ImportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ImportNotifier will be invalid.

in_thatThe source IONotifier to copy.

Member Function Documentation

◆ Assign()

void HPS.HCA.ImportNotifier.Assign ( HPS.HCA.ImportNotifier  in_that)

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

in_thatThe source ImportNotifier for the assignment.

◆ GetTarget()

HPS.Model HPS.HCA.ImportNotifier.GetTarget ( )

Get the the Model where the Stream Cache file was imported into. Throws an IOException if the import is not complete or was not successful.

The Model containing the Stream Cache file for a successful file import.

◆ ObjectType()

override HPS.Type HPS.HCA.ImportNotifier.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).

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:
  • internals/hps_sprk_hca/source/cs/HPS.HCA.cs