NexusCPP  3.5.0
Public Member Functions | List of all members
nxcpp::AxisDatasetWriter< TYPE > Class Template Reference

#include <nxwriter.h>

Inheritance diagram for nxcpp::AxisDatasetWriter< TYPE >:
Inheritance graph
[legend]
Collaboration diagram for nxcpp::AxisDatasetWriter< TYPE >:
Collaboration graph
[legend]

Public Member Functions

 AxisDatasetWriter (int iDim, int iSize, int iOrder=1)
 
 ~AxisDatasetWriter ()
 d-tor More...
 
void PushPosition (TYPE TValue)
 
- Public Member Functions inherited from nxcpp::DatasetWriter
template<class TYPE >
void SetDataType ()
 Sets the NeXus dataset type according to the class invoked through the template. More...
 
void Reset ()
 reset the writer in order to re-using it More...
 
void SetNeXusDataType (NexusDataType eDataType)
 Sets the NeXus dataset type. More...
 
void SetShapes (const DataShape &shapeDataItem, const DataShape &shapeMatrix)
 
void set_compression (CompressionFilter filter=CompressZLIB, FilterConfig filter_config=FilterConfig())
 Set compression parameters. More...
 
 DatasetWriter (const DataShape &shapeDataItem, const DataShape &shapeMatrix=g_empty_shape, yat::uint16 usMaxMB=64, yat::uint16 m_usWriteTimeout=0)
 
 DatasetWriter (const DataShape &shapeDataItem, std::size_t one_dim_size, yat::uint16 usMaxMB=64, yat::uint16 m_usWriteTimeout=0)
 
 DatasetWriter (yat::uint16 usMaxMB=64, yat::uint16 m_usWriteTimeout=0)
 
 DatasetWriter (const Config &cfg)
 
virtual ~DatasetWriter ()
 d-tor More...
 
void SetNexusFileWriter (NexusFileWriterPtr ptrWriter)
 
void SetFlushListener (IFlushNotification *pListener)
 
void SetMatrix (const DataShape &shapeMatrix=g_empty_shape)
 
void SetPath (const std::string &strPath, const std::string &strDataset)
 Change destination path. More...
 
void SetFullPath (const std::string &strFullPath)
 Change destination path. More...
 
void SetDatasetName (const std::string &strDatasetName)
 Set the dataset name. More...
 
void SetCacheSize (yat::uint16 usMaxMB)
 Sets the buffer size in Mega bytes. More...
 
void AddAttribute (const NexusAttrPtr &ptrAttr)
 Adding integer-type attribute to the NeXus dataset. More...
 
void AddFloatAttribute (const std::string &strName, double dValue)
 Adding double-type attribute to the NeXus dataset. More...
 
void AddIntegerAttribute (const std::string &strName, long lValue)
 Adding integer-type attribute to the NeXus dataset. More...
 
void AddStringAttribute (const std::string &strName, const std::string &strValue)
 Adding std::string-type attribute to the NeXus dataset. More...
 
void PushData (const void *pData, std::size_t nDataCount=1, bool bNoCopy=false)
 Push data. More...
 
void Stop ()
 No more data to push, data is flushed to the NeXus file writer. More...
 
void Abort ()
 Cancel => forget all. More...
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<>
void SetDataType ()
 
template<class TYPE >
void SetDataType ()
 
template<class TYPE >
void AdjustSizes ()
 
 DatasetWriter (const std::vector< int > &, const std::vector< int > &, yat::uint16 usMaxMB=64)
 
 DatasetWriter (const std::vector< int > &, std::size_t, yat::uint16 usMaxMB=64)
 
const DataShapeMatrixShape () const
 
DataShape DataItemShape () const
 
NexusDataType DataType () const
 
std::string FullPath () const
 
const std::string & DatasetName () const
 
std::size_t TotalRank () const
 
std::size_t DataItemCount () const
 
yat::uint64 TotalSize () const
 
yat::uint32 DataItemSize () const
 
yat::uint32 MaxDataItemsCount () const
 

Additional Inherited Members

- Public Types inherited from nxcpp::DatasetWriter
typedef struct nxcpp::DatasetWriter::Config Config
 DatasetWriter configuration. More...
 

Detailed Description

template<class TYPE>
class nxcpp::AxisDatasetWriter< TYPE >

AxisDatasetWriter

Typed DatasetWriter class dedicated to for axis data

Constructor & Destructor Documentation

◆ AxisDatasetWriter()

template<class TYPE >
AxisDatasetWriter::AxisDatasetWriter ( int  iDim,
int  iSize,
int  iOrder = 1 
)

c-tor

Parameters
iDimDimension number of axis
iSizeDimension length
iOrderAxis order in the dimension
Here is the call graph for this function:

◆ ~AxisDatasetWriter()

template<class TYPE >
nxcpp::AxisDatasetWriter< TYPE >::~AxisDatasetWriter ( )
inline

d-tor

Member Function Documentation

◆ PushPosition()

template<class TYPE >
void AxisDatasetWriter::PushPosition ( TYPE  TValue)
Here is the call graph for this function:

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