openPMD-api
Public Types | Public Member Functions | Protected Attributes | List of all members
openPMD::DatasetFiller< T > Class Template Referenceabstract

An abstract class to create one iteration of data per thread. More...

#include <DatasetFiller.hpp>

Public Types

using resultType = T
 

Public Member Functions

 DatasetFiller (Extent::value_type numberOfItems=0)
 
virtual ~DatasetFiller ()=default
 This class will be derived from.
 
virtual std::shared_ptr< T > produceData ()=0
 Create a shared pointer of m_numberOfItems items of type T. More...
 
virtual void setNumberOfItems (Extent::value_type numberOfItems)=0
 Set number of items to be produced. More...
 

Protected Attributes

Extent::value_type m_numberOfItems
 

Detailed Description

template<typename T>
class openPMD::DatasetFiller< T >

An abstract class to create one iteration of data per thread.

Template Parameters
TThe type of data to produce.

Member Function Documentation

◆ produceData()

template<typename T >
virtual std::shared_ptr< T > openPMD::DatasetFiller< T >::produceData ( )
pure virtual

Create a shared pointer of m_numberOfItems items of type T.

Should take roughly the same amount of time per call as long as m_numberOfItems does not change.

Returns

Implemented in openPMD::RandomDatasetFiller< Distr, T >.

◆ setNumberOfItems()

template<typename T >
virtual void openPMD::DatasetFiller< T >::setNumberOfItems ( Extent::value_type  numberOfItems)
pure virtual

Set number of items to be produced.

Parameters
numberOfItemsThe number.

Implemented in openPMD::RandomDatasetFiller< Distr, T >.


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