HPS::Stream::Toolkit

class HPS::Stream::Toolkit : public HPS::Object

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

Public Functions

inline virtual HPS::Type ObjectType() const

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.

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_toolkit – An rvalue reference to a Toolkit to take the impl from.

Returns

A reference to this Toolkit.

Toolkit &operator=(Toolkit const &in_toolkit)

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

Parameters

in_toolkit – The source Toolkit for the assignment.

Returns

A reference to this ShellKey.

ImportNotifier ParseBuffers(ByteArrayArray const &in_hsf_buffers, ImportOptionsKit const &in_options)

virtual void Restart()

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

Toolkit()

The Default constructor creates an empty Toolkit object.

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_toolkit – An rvalue reference to a Toolkit to take the impl from.

Toolkit(Toolkit const &in_toolkit)

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

Parameters

in_toolkit – The source Toolkit to copy.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::StreamToolkit