|
NexusCPP
3.5.0
|
#include <nxwriter.h>


Classes | |
| struct | Config |
| DatasetWriter configuration. More... | |
| class | IFlushNotification |
Public Types | |
| typedef struct nxcpp::DatasetWriter::Config | Config |
| DatasetWriter configuration. More... | |
Public Types inherited from nxcpp::MMetadata | |
| enum | Type { NONE = 0, STRING, INT, LONGINT, DOUBLE } |
Public Member Functions | |
| 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 DataShape & | MatrixShape () 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 |
Public Member Functions inherited from nxcpp::MMetadata | |
| void | AddMetadata (const std::string &strKey, const std::string &strValue) |
| void | AddMetadata (const std::string &strKey, const char *pszValue) |
| void | AddMetadata (const std::string &strKey, int iValue) |
| void | AddMetadata (const std::string &strKey, long lValue) |
| void | AddMetadata (const std::string &strKey, double dValue) |
| bool | HasMetadata (const std::string &strKey) const |
| bool | GetMetadata (const std::string &strKey, std::string *pstrValue, bool bThrow=true) const |
| bool | GetStringMetadata (const std::string &strKey, std::string *pstrValue, bool bThrow=true) const |
| std::string | StringMetadata (const std::string &strKey) const |
| bool | GetIntegerMetadata (const std::string &strKey, int *piValue, bool bThrow=true) const |
| int | IntegerMetadata (const std::string &strKey) const |
| bool | GetLongIntegerMetadata (const std::string &strKey, long *plValue, bool bThrow=true) const |
| long | LongIntegerMetadata (const std::string &strKey) const |
| bool | GetDoubleMetadata (const std::string &strKey, double *pdValue, bool bThrow=true) const |
| double | DoubleMetadata (const std::string &strKey) const |
| Type | GetMetadataType (const std::string &strKey, bool bThrow=true) const |
| std::list< std::string > | MetadataKeys () const |
| Returns the metadata keys std::list. More... | |
| void | ClearMetadata () |
| Clear all metadata. More... | |
class containing a NexusDataset with its attributes and its location
| typedef struct nxcpp::DatasetWriter::Config nxcpp::DatasetWriter::Config |
DatasetWriter configuration.
| nxcpp::DatasetWriter::DatasetWriter | ( | const DataShape & | shapeDataItem, |
| const DataShape & | shapeMatrix = g_empty_shape, |
||
| yat::uint16 | usMaxMB = 64, |
||
| yat::uint16 | m_usWriteTimeout = 0 |
||
| ) |
Main constructor
| shapeDataItem | Shape of the canonical data |
| shapeMatrix | Shape of the acquisition |
| usMaxMB | Cache size |
| m_usWriteTimeout | Max time before flushing cached data |
| nxcpp::DatasetWriter::DatasetWriter | ( | const DataShape & | shapeDataItem, |
| std::size_t | one_dim_size, | ||
| yat::uint16 | usMaxMB = 64, |
||
| yat::uint16 | m_usWriteTimeout = 0 |
||
| ) |
Convenience constructor for 1-D scan
| shapeDataItem | Shape of the canonical data |
| one_dim_size | Scan length |
| usMaxMB | Cache size |
| m_usWriteTimeout | Max time before flushing cached data |
| nxcpp::DatasetWriter::DatasetWriter | ( | yat::uint16 | usMaxMB = 64, |
| yat::uint16 | m_usWriteTimeout = 0 |
||
| ) |
Use this constructor when shapes are now known yet
| usMaxMB | Cache size |
| m_usWriteTimeout | Max time before flushing cached data |
| nxcpp::DatasetWriter::DatasetWriter | ( | const Config & | cfg | ) |
| nxcpp::DatasetWriter::DatasetWriter | ( | const std::vector< int > & | , |
| const std::vector< int > & | , | ||
| yat::uint16 | usMaxMB = 64 |
||
| ) |
| nxcpp::DatasetWriter::DatasetWriter | ( | const std::vector< int > & | , |
| std::size_t | , | ||
| yat::uint16 | usMaxMB = 64 |
||
| ) |
|
virtual |
d-tor
| void nxcpp::DatasetWriter::Abort | ( | ) |
Cancel => forget all.
| void nxcpp::DatasetWriter::AddAttribute | ( | const NexusAttrPtr & | ptrAttr | ) |
Adding integer-type attribute to the NeXus dataset.
| void nxcpp::DatasetWriter::AddFloatAttribute | ( | const std::string & | strName, |
| double | dValue | ||
| ) |
Adding double-type attribute to the NeXus dataset.
| void nxcpp::DatasetWriter::AddIntegerAttribute | ( | const std::string & | strName, |
| long | lValue | ||
| ) |
Adding integer-type attribute to the NeXus dataset.

| void nxcpp::DatasetWriter::AddStringAttribute | ( | const std::string & | strName, |
| const std::string & | strValue | ||
| ) |
Adding std::string-type attribute to the NeXus dataset.
| void nxcpp::DatasetWriter::AdjustSizes | ( | ) |
|
inline |
| DataShape nxcpp::DatasetWriter::DataItemShape | ( | ) | const |
|
inline |
|
inline |
|
inline |
| std::string nxcpp::DatasetWriter::FullPath | ( | ) | const |
|
inline |
|
inline |
| void nxcpp::DatasetWriter::PushData | ( | const void * | pData, |
| std::size_t | nDataCount = 1, |
||
| bool | bNoCopy = false |
||
| ) |
Push data.

| void nxcpp::DatasetWriter::Reset | ( | ) |
reset the writer in order to re-using it
| void nxcpp::DatasetWriter::set_compression | ( | CompressionFilter | filter = CompressZLIB, |
| FilterConfig | filter_config = FilterConfig() |
||
| ) |
Set compression parameters.
|
inline |
Sets the buffer size in Mega bytes.
| void nxcpp::DatasetWriter::SetDatasetName | ( | const std::string & | strDatasetName | ) |
Set the dataset name.
|
inline |
Synchrotron SOLEIL
Nexus C++ API over NAPI
Creation : 2010/07/18 Author : Stephane Poirier
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void nxcpp::DatasetWriter::SetDataType | ( | ) |
| void nxcpp::DatasetWriter::SetDataType | ( | ) |
Sets the NeXus dataset type according to the class invoked through the template.
|
inline |
Set the flushing notification listener Must be called before push any data, like after construction or a call to the Stop method
| pListener | pointer to the listener |
| void nxcpp::DatasetWriter::SetFullPath | ( | const std::string & | strFullPath | ) |
Change destination path.
| void nxcpp::DatasetWriter::SetMatrix | ( | const DataShape & | shapeMatrix = g_empty_shape | ) |
Resizes matrix Must be called before push any data, like after construction or a call to the Stop method
| shapeMatrix | new shape |
| void nxcpp::DatasetWriter::SetNeXusDataType | ( | NexusDataType | eDataType | ) |
Sets the NeXus dataset type.
| void nxcpp::DatasetWriter::SetNexusFileWriter | ( | NexusFileWriterPtr | ptrWriter | ) |
Set Nexus file writer object Must be called before push any data, like after construction or a call to the Stop method
| ptrWriter | referenced pointer to the new writer object |
| void nxcpp::DatasetWriter::SetPath | ( | const std::string & | strPath, |
| const std::string & | strDataset | ||
| ) |
Change destination path.
| void nxcpp::DatasetWriter::SetShapes | ( | const DataShape & | shapeDataItem, |
| const DataShape & | shapeMatrix | ||
| ) |
Set dataset shape
| shapeDataItem | shape of the canonical data |
| shapeMatrix | shape of the acquisition |

| void nxcpp::DatasetWriter::Stop | ( | ) |
No more data to push, data is flushed to the NeXus file writer.
|
inline |
|
inline |
1.8.13