API Search || Global Search

More...

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

Public Member Functions

override void Dispose ()
 
override HPS.Type 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). More...
 
HPS.Stream.ImportNotifier ParseBuffers (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)
 
virtual void Restart ()
 Restarts the Toolkit object so that it can be reused for importing or exporting. More...
 
 Toolkit ()
 The Default constructor creates an empty Toolkit object. More...
 
 Toolkit (HPS.Stream.Toolkit in_toolkit)
 This constructor creates an Toolkit object that shares the underlying smart-pointer of the source Toolkit. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual 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...
 

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

HPS.Stream.Toolkit.Toolkit ( )
inline

The Default constructor creates an empty Toolkit object.

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

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.

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