NexusCPP  3.5.0
Public Member Functions | Public Attributes | List of all members
nxcpp::DataStreamer::Config Struct Reference

DataStreamer configuration structure. More...

#include <nxbuffer.h>

Collaboration diagram for nxcpp::DataStreamer::Config:
Collaboration graph
[legend]

Public Member Functions

 Config ()
 c-tor More...
 

Public Attributes

yat::String buffer_name
 buffer file names suffix More...
 
std::size_t acquisition_size
 total number of data (may be either scalars, spectrums or images) More...
 
std::size_t buffer_size
 number of data to be stored into one buffer file More...
 
yat::String target_path
 Target directory for streamed data. More...
 
yat::String data_source
 
WriteNotificationCallback write_notif_cb
 The optional write notification callback. More...
 
NexusFileWriter::WriteMode write_mode
 SYNCHRONOUS OR ASYNCHRONOUS writing mode. More...
 
FilterConfig filter_config
 Compresssion filter options. More...
 
CompressionFilter compress_filter
 Compression filer. More...
 
std::size_t min_bytes_for_compression
 Minimum uncompressed byte size of data item that will be compressed. More...
 
yat::String device_name
 The data source device name. More...
 
IMessageHandlermessage_handler_p
 Messages logging handler. More...
 
bool throw_if_file_exists
 Throw an exception if destination buffer file already exists ? More...
 
IExceptionHandlerexception_handler_p
 optional exception handler More...
 
std::size_t max_attempts
 max attempts on write access in case of error More...
 
std::size_t retry_delay
 delay between each try in ms More...
 

Detailed Description

DataStreamer configuration structure.

Constructor & Destructor Documentation

◆ Config()

nxcpp::DataStreamer::Config::Config ( )
inline

c-tor

Member Data Documentation

◆ acquisition_size

std::size_t nxcpp::DataStreamer::Config::acquisition_size

total number of data (may be either scalars, spectrums or images)

◆ buffer_name

yat::String nxcpp::DataStreamer::Config::buffer_name

buffer file names suffix

◆ buffer_size

std::size_t nxcpp::DataStreamer::Config::buffer_size

number of data to be stored into one buffer file

◆ compress_filter

CompressionFilter nxcpp::DataStreamer::Config::compress_filter

Compression filer.

◆ data_source

yat::String nxcpp::DataStreamer::Config::data_source

Data source root name. data file will ba named using this name followed by a index number

◆ device_name

yat::String nxcpp::DataStreamer::Config::device_name

The data source device name.

◆ exception_handler_p

IExceptionHandler* nxcpp::DataStreamer::Config::exception_handler_p

optional exception handler

◆ filter_config

FilterConfig nxcpp::DataStreamer::Config::filter_config

Compresssion filter options.

◆ max_attempts

std::size_t nxcpp::DataStreamer::Config::max_attempts

max attempts on write access in case of error

◆ message_handler_p

IMessageHandler* nxcpp::DataStreamer::Config::message_handler_p

Messages logging handler.

◆ min_bytes_for_compression

std::size_t nxcpp::DataStreamer::Config::min_bytes_for_compression

Minimum uncompressed byte size of data item that will be compressed.

◆ retry_delay

std::size_t nxcpp::DataStreamer::Config::retry_delay

delay between each try in ms

◆ target_path

yat::String nxcpp::DataStreamer::Config::target_path

Target directory for streamed data.

◆ throw_if_file_exists

bool nxcpp::DataStreamer::Config::throw_if_file_exists

Throw an exception if destination buffer file already exists ?

◆ write_mode

NexusFileWriter::WriteMode nxcpp::DataStreamer::Config::write_mode

SYNCHRONOUS OR ASYNCHRONOUS writing mode.

◆ write_notif_cb

WriteNotificationCallback nxcpp::DataStreamer::Config::write_notif_cb

The optional write notification callback.


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