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 (Ice::optional< int > sampleCount=Ice::nullopt, Ice::optional< int > sampleLifetime=Ice::nullopt, Ice::optional< ClearHistoryPolicy > clearHistory=Ice::nullopt) noexcept
	Construct a Config object. More...

Public Attributes
Ice::optional< int >	sampleCount
	The sampleCount configuration specifies how many samples are kept by the reader or writer in its sample history. More...

Ice::optional< int >	sampleLifetime
	The sampleLifetime configuration specifies samples to keep in the writer or reader history based on their age. More...

Ice::optional< ClearHistoryPolicy >	clearHistory
	The clear history policy specifies when samples are removed from the sample history. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ Config()

DataStorm::Config::Config	(	Ice::optional< int >	sampleCount = `Ice::nullopt`,
		Ice::optional< int >	sampleLifetime = `Ice::nullopt`,
		Ice::optional< ClearHistoryPolicy >	clearHistory = `Ice::nullopt`
	)

inlinenoexcept

Construct a Config object.

The constructor accepts optional parameters for each of the Config data members.

Parameters

sampleCount	The optional sample count.
sampleLifetime	The optional sample lifetime.
clearHistory	The optional clear history policy.

Member Data Documentation

◆ clearHistory

Ice::optional<ClearHistoryPolicy> DataStorm::Config::clearHistory

The clear history policy specifies when samples are removed from the sample history.

By default, samples are removed when a new sample is is received which effectively disables the sample history.

◆ sampleCount

Ice::optional<int> DataStorm::Config::sampleCount

The sampleCount configuration specifies how many samples are kept by the reader or writer in its sample history.

By default, the sample count is unlimited.

◆ sampleLifetime

Ice::optional<int> DataStorm::Config::sampleLifetime

The sampleLifetime configuration specifies samples to keep in the writer or reader history based on their age.

Samples with a timestamp older than the sampleLifetime value (in milliseconds) are discarded from the history. By default, the samples are kept for an unlimited amount of time.

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

cpp/include/DataStorm/Types.h

Public Member Functions