|
NexusCPP
3.5.0
|
Classes | |
| class | AxisDatasetWriter |
| class | DatasetWriter |
| class | DataStreamer |
| class | GenericDatasetWriter |
| class | IExceptionHandler |
| Exception handling interface. More... | |
| class | IMessageHandler |
| Message handling interface. More... | |
| class | MMetadata |
| Mix-in that add metadata capabilitie to objects. More... | |
| class | NexusAttr |
| class | NexusAttrInfo |
| class | NexusDataSet |
| class | NexusDataSetInfo |
| class | NexusDataStreamerFinalizer |
| NexusDataStreamerFinalizer. More... | |
| class | NexusException |
| class | NexusFile |
| class | NexusFileWriter |
| class | NexusGlobalLock |
| class | NexusItemID |
| class | NexusItemInfo |
| class | OverwriteError |
| class | SignalDatasetWriter |
| struct | WriteNotification |
| Write notification. More... | |
Typedefs | |
| typedef std::vector< std::size_t > | shape_t |
| typedef std::map< FilterOption, int > | FilterConfig |
| Filter options to be passed with CreateCompressedDataSet method. More... | |
| typedef yat::SharedPtr< NexusItemInfo > | NexusItemInfoPtr |
| Smart pointer definition helper. More... | |
| typedef std::list< NexusItemInfoPtr > | NexusItemInfoList |
| ItemInfo smart pointers list definition helper. More... | |
| typedef std::list< NexusAttr > | NeXusAttrList |
| definition of a attribute collection More... | |
| typedef yat::SharedPtr< NexusDataSet, yat::Mutex > | NexusDataSetPtr |
| typedef yat::SharedPtr< NexusAttr, yat::Mutex > | NexusAttrPtr |
| typedef yat::MemBuf | DatasetBuf |
| typedef yat::SharedPtr< NexusFileWriter, yat::Mutex > | NexusFileWriterPtr |
| Referenced pointer definition. More... | |
| typedef std::vector< std::size_t > | DataShape |
| Data shape type. More... | |
| typedef yat::SharedPtr< DatasetWriter, yat::Mutex > | DatasetWriterPtr |
| Shared pointer definition. More... | |
Enumerations | |
| enum | DataItemCategory { NX_GENERIC = 1, NX_AXIS = 2, NX_DATA_SIGNAL = 3, NX_DATA = 4 } |
| enum | FilterOption { compression_level, bitshuffle_compression, bitshuffle_block_size } |
| id list of all filters options More... | |
| enum | CompressionFilter { CompressNone, CompressZLIB, CompressLZ4, CompressBsLZ4, CompressZstd, CompressBlosc2, CompressBzip2 } |
| List of known compression filters. More... | |
| enum | NexusDataType { NX_NONE = 0, NX_CHAR = 4, NX_FLOAT32 = 5, NX_FLOAT64 = 6, NX_INT8 = 20, NX_UINT8 = 21, NX_INT16 = 22, NX_UINT16 = 23, NX_INT32 = 24, NX_UINT32 = 25, NX_INT64 = 26, NX_UINT64 = 27, NX_BINARY = 21, ISO8601 = 100, NX_INT = 102, NX_FLOAT = 103 } |
| enum | NexusRC { NX_OK = 1, NX_EOD = -1, NX_ITEM_NOT_FOUND = -2 } |
| NeXus return codes. More... | |
| enum | ENexusCreateMode { NX_HDF4 = 0, NX_HDF5, NX_XML } |
Functions | |
| YAT_DEFINE_CALLBACK (WriteNotificationCallback, WriteNotification) | |
| Write notification callback. More... | |
| NEXUSCPP_DECL bool | IsCompressFilterAvailable (CompressionFilter filter_id) |
| NEXUSCPP_DECL std::set< CompressionFilter > | AvailableCompressFilters () |
| Return the available compress filters. More... | |
| NEXUSCPP_DECL const char * | get_version () |
| Free function: provide project version & name. More... | |
| NEXUSCPP_DECL const char * | get_name () |
| void | message_to_console (yat::ELogLevel lvl, const yat::String &msg) |
| void | exception_to_console (const yat::Exception &e) |
Variables | |
| const int | MAX_NAME_LENGTH = 256 |
| const int | MAX_DATASET_NDIMS = 256 |
| const char | DATASET_CLASS [] = "SDS" |
| const std::string | g_strNoDataSet = "(no data set)" |
| const int | MAX_RANK = 32 |
| Max datasets rank. More... | |
| const std::size_t | kDEFAULT_PULSER_PERIOD = 3000 |
| const DataShape | g_empty_shape |
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.
Synchrotron SOLEIL
NeXus C++ API
Creation : 16/02/2005 Authors : Stephane Poirier, Clement Rodriguez, Nicolas Leclerc, Julien Berthaud
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.
| typedef yat::MemBuf nxcpp::DatasetBuf |
| typedef yat::SharedPtr<DatasetWriter, yat::Mutex> nxcpp::DatasetWriterPtr |
Shared pointer definition.
| typedef std::vector<std::size_t> nxcpp::DataShape |
Data shape type.
| typedef std::map<FilterOption, int> nxcpp::FilterConfig |
Filter options to be passed with CreateCompressedDataSet method.
| typedef std::list<NexusAttr> nxcpp::NeXusAttrList |
definition of a attribute collection
| typedef yat::SharedPtr<NexusAttr, yat::Mutex> nxcpp::NexusAttrPtr |
| typedef yat::SharedPtr<NexusDataSet, yat::Mutex> nxcpp::NexusDataSetPtr |
| typedef yat::SharedPtr<NexusFileWriter, yat::Mutex> nxcpp::NexusFileWriterPtr |
Referenced pointer definition.
| typedef std::list<NexusItemInfoPtr> nxcpp::NexusItemInfoList |
ItemInfo smart pointers list definition helper.
| typedef yat::SharedPtr<NexusItemInfo> nxcpp::NexusItemInfoPtr |
Smart pointer definition helper.
| typedef std::vector<std::size_t> nxcpp::shape_t |
List of known compression filters.
This enumerate all known filter but all filters are not necesseraly implemented. Check filter availability using the free functions IsCompressFilterAvailable & AvailableCompressFilters
| Enumerator | |
|---|---|
| CompressNone | |
| CompressZLIB | |
| CompressLZ4 | |
| CompressBsLZ4 | |
| CompressZstd | |
| CompressBlosc2 | |
| CompressBzip2 | |
| enum nxcpp::FilterOption |
| enum nxcpp::NexusDataType |
| enum nxcpp::NexusRC |
| NEXUSCPP_DECL std::set<CompressionFilter> nxcpp::AvailableCompressFilters | ( | ) |
Return the available compress filters.
| void nxcpp::exception_to_console | ( | const yat::Exception & | e | ) |
| NEXUSCPP_DECL const char* nxcpp::get_name | ( | ) |

| NEXUSCPP_DECL const char* nxcpp::get_version | ( | ) |
Free function: provide project version & name.

| NEXUSCPP_DECL bool nxcpp::IsCompressFilterAvailable | ( | CompressionFilter | filter_id | ) |
Return 'true' if the given compression filter is currently available
| filter_id | filter identifier |
| void nxcpp::message_to_console | ( | yat::ELogLevel | lvl, |
| const yat::String & | msg | ||
| ) |
| nxcpp::YAT_DEFINE_CALLBACK | ( | WriteNotificationCallback | , |
| WriteNotification | |||
| ) |
Write notification callback.
| const char nxcpp::DATASET_CLASS[] = "SDS" |
| const DataShape nxcpp::g_empty_shape |
| const std::string nxcpp::g_strNoDataSet = "(no data set)" |
| const std::size_t nxcpp::kDEFAULT_PULSER_PERIOD = 3000 |
| const int nxcpp::MAX_DATASET_NDIMS = 256 |
| const int nxcpp::MAX_NAME_LENGTH = 256 |
| const int nxcpp::MAX_RANK = 32 |
Max datasets rank.
1.8.13