HPS.Exchange.ReloadNotifier Class Reference
Inheritance diagram for HPS.Exchange.ReloadNotifier:
HPS.IONotifier HPS.Object

Public Member Functions

void Assign (HPS.Exchange.ReloadNotifier in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
 ReloadNotifier ()
 
 ReloadNotifier (HPS.Exchange.ReloadNotifier in_that)
 
 ReloadNotifier (HPS.IONotifier in_that)
 
- 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 ReloadNotifier class is a smart-pointer that is tied to a Component.Reload or a CADModel.Reload. It is used to interact with an ongoing reload.

Constructor & Destructor Documentation

◆ ReloadNotifier() [1/3]

HPS.Exchange.ReloadNotifier.ReloadNotifier ( )
inline

The default constructor creates an ReloadNotifier object which is not tied to any component reload.

◆ ReloadNotifier() [2/3]

HPS.Exchange.ReloadNotifier.ReloadNotifier ( HPS.Exchange.ReloadNotifier  in_that)
inline

The copy constructor creates a new ReloadNotifier object that is associated with the same component reload as the source ReloadNotifier.

Parameters
in_thatThe source ReloadNotifier to copy.

◆ ReloadNotifier() [3/3]

HPS.Exchange.ReloadNotifier.ReloadNotifier ( HPS.IONotifier  in_that)
inline

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

Parameters
in_thatThe source IONotifier to copy.

Member Function Documentation

◆ Assign()

void HPS.Exchange.ReloadNotifier.Assign ( HPS.Exchange.ReloadNotifier  in_that)
inline

Associate this ReloadNotifier with the same component reload as the source ReloadNotifier.

Parameters
in_thatThe source ReloadNotifier for the assignment.

◆ ObjectType()

override HPS.Type HPS.Exchange.ReloadNotifier.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.IONotifier.


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