Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
DataStorm::Config Class Reference

The configuration base class holds configuration options common to readers and writers. More...

#include <DataStorm/DataStorm.h>

Inheritance diagram for DataStorm::Config:

Public Member Functions

 Config (std::optional< int > sampleCount=std::nullopt, std::optional< int > sampleLifetime=std::nullopt, std::optional< ClearHistoryPolicy > clearHistory=std::nullopt) noexcept
 Constructs a Config object.

Public Attributes

std::optional< ClearHistoryPolicyclearHistory
 The clear history policy specifies when the sample history is cleared.
std::optional< int > sampleCount
 The sampleCount configuration specifies how many samples are kept by the reader or writer in its sample history.
std::optional< int > sampleLifetime
 The sampleLifetime configuration specifies samples to keep in the writer or reader history based on their age.

Detailed Description

The configuration base class holds configuration options common to readers and writers.

A configuration option set to nullopt is resolved from the topic's default reader or writer configuration (see Topic::setReaderDefaultConfig and Topic::setWriterDefaultConfig), and ultimately from the corresponding DataStorm.Topic.* property.

Definition at line 68 of file Types.h.


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