HPS.OBJ.ExportNotifier Class Reference
Inheritance diagram for HPS.OBJ.ExportNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

void Assign (HPS.OBJ.ExportNotifier in_that)
override void Dispose ()
 ExportNotifier ()
 ExportNotifier (HPS.OBJ.ExportNotifier in_that)
 ExportNotifier (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 ExportNotifier class is a smart-pointer that is associated with an asynchronous file export. It is used to interact with an ongoing export or get the results from a completed export.

Constructor & Destructor Documentation

◆ ExportNotifier() [1/3]

HPS.OBJ.ExportNotifier.ExportNotifier ( )

The default constructor creates an ExportNotifier object which is not associated with any file export.

◆ ExportNotifier() [2/3]

HPS.OBJ.ExportNotifier.ExportNotifier ( HPS.OBJ.ExportNotifier  in_that)

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

in_thatThe source ExportNotifier to copy.

◆ ExportNotifier() [3/3]

HPS.OBJ.ExportNotifier.ExportNotifier ( HPS.IONotifier  in_that)

The conversion constructor creates a new derived ExportNotifier 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 ExportNotifier will be invalid.

in_thatThe source IONotifier to copy.

Member Function Documentation

◆ Assign()

void HPS.OBJ.ExportNotifier.Assign ( HPS.OBJ.ExportNotifier  in_that)

Associate this ExportNotifier with the same file export as the source ExportNotifier.

in_thatThe source ExportNotifier for the assignment.

◆ ObjectType()

override HPS.Type HPS.OBJ.ExportNotifier.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_core/source/cs/HPS.OBJ.cs