Inheritance diagram for HPS.Stream.Toolkit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.Stream.ImportNotifier ParseBuffers (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)
 
virtual void Restart ()
 
 Toolkit ()
 
 Toolkit (HPS.Stream.Toolkit in_toolkit)
 
- 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 Toolkit class is the primary support class which manages streaming of HSF data.

Constructor & Destructor Documentation

◆ Toolkit() [1/2]

HPS.Stream.Toolkit.Toolkit ( )
inline

The Default constructor creates an empty Toolkit object.

◆ Toolkit() [2/2]

HPS.Stream.Toolkit.Toolkit ( HPS.Stream.Toolkit  in_toolkit)
inline

This constructor creates an Toolkit object that shares the underlying smart-pointer of the source Toolkit.

Parameters
in_toolkitThe source Toolkit to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.Stream.Toolkit.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.Object.

◆ Restart()

virtual void HPS.Stream.Toolkit.Restart ( )
inlinevirtual

Restarts the Toolkit object so that it can be reused for importing or exporting.


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