Poplar and PopLibs
poplar::StreamCallbackWithMetadata Class Reference

Interface used to add support for stream copies to produce/consume data if the data type requires metadata. More...

#include <StreamCallback.hpp>

Inheritance diagram for poplar::StreamCallbackWithMetadata:
poplar::StreamCallback

Public Member Functions

QuarterMetadata getMetadata () const
 Get the binary representation of metadata on the host. More...
 
void setMetadata (QuarterMetadata md)
 Set the binary representation of metadata on the host. More...
 
- Public Member Functions inherited from poplar::StreamCallback
virtual Result prefetch (void *p)=0
 Callback function to fill the host buffer (host-to-device streams only). More...
 
virtual void fetch (void *)=0
 Callback function to fill the host buffer. More...
 

Detailed Description

Interface used to add support for stream copies to produce/consume data if the data type requires metadata.

Member Function Documentation

◆ getMetadata()

QuarterMetadata poplar::StreamCallbackWithMetadata::getMetadata ( ) const
inline

Get the binary representation of metadata on the host.

Returns
Metadata value.

◆ setMetadata()

void poplar::StreamCallbackWithMetadata::setMetadata ( QuarterMetadata  md)
inline

Set the binary representation of metadata on the host.

Parameters
mdMetadata value.

The documentation for this class was generated from the following file: