HPS::Stream::Toolkit Class Reference

#include <hps.h>

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

Public Member Functions

HPS::Type ObjectType () const
 
Toolkitoperator= (Toolkit const &in_toolkit)
 
Toolkitoperator= (Toolkit &&in_toolkit)
 
ImportNotifier ParseBuffers (ByteArrayArray const &in_hsf_buffers, ImportOptionsKit const &in_options)
 
virtual void Restart ()
 
 Toolkit ()
 
 Toolkit (Toolkit const &in_toolkit)
 
 Toolkit (Toolkit &&in_toolkit)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::StreamToolkit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The Toolkit class is the primary support class which manages streaming of HSF data.

Constructor & Destructor Documentation

◆ Toolkit() [1/3]

HPS::Stream::Toolkit::Toolkit ( )

The Default constructor creates an empty Toolkit object.

◆ Toolkit() [2/3]

HPS::Stream::Toolkit::Toolkit ( Toolkit const &  in_toolkit)

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

Parameters
in_toolkitThe source Toolkit to copy.

◆ Toolkit() [3/3]

HPS::Stream::Toolkit::Toolkit ( Toolkit &&  in_toolkit)

The move constructor creates a Toolkit by transferring the underlying impl of the rvalue reference to this Toolkit thereby avoiding a copy and allocation.

Parameters
in_toolkitAn rvalue reference to a Toolkit to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::Stream::Toolkit::ObjectType ( ) const
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.

◆ operator=() [1/2]

Toolkit& HPS::Stream::Toolkit::operator= ( Toolkit const &  in_toolkit)

Associate this Toolkit with the same underlying impl as the source Toolkit.

Parameters
in_toolkitThe source Toolkit for the assignment.
Returns
A reference to this ShellKey.

◆ operator=() [2/2]

Toolkit& HPS::Stream::Toolkit::operator= ( Toolkit &&  in_toolkit)

The move assignment operator transfers the underlying impl of the rvalue reference to this Toolkit thereby avoiding a copy.

Parameters
in_toolkitAn rvalue reference to a Toolkit to take the impl from.
Returns
A reference to this Toolkit.

◆ Restart()

virtual void HPS::Stream::Toolkit::Restart ( )
virtual

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: