RTI Connext C# API Version 7.3.0
Rti.Dds.Core.Policy.HistoryBuilder Class Reference

A modifiable type used to create an immutable History More...

Public Member Functions

 HistoryBuilder (History data)
 Creates a builder with the values of an existing immutable instance More...
 
History Build ()
 Creates a new History immutable object from this one. More...
 

Properties

HistoryKind Kind [get, set]
 Specifies the kind of history to be kept. More...
 
int Depth [get, set]
 Specifies the number of samples to be kept, when Kind is HistoryKind.KeepLast More...
 

Detailed Description

A modifiable type used to create an immutable History

Constructor & Destructor Documentation

◆ HistoryBuilder()

Rti.Dds.Core.Policy.HistoryBuilder.HistoryBuilder ( History  data)
inline

Creates a builder with the values of an existing immutable instance

Member Function Documentation

◆ Build()

History Rti.Dds.Core.Policy.HistoryBuilder.Build ( )

Creates a new History immutable object from this one.

Property Documentation

◆ Kind

HistoryKind Rti.Dds.Core.Policy.HistoryBuilder.Kind
getset

Specifies the kind of history to be kept.

The full documentation is available in the C API: DDS_HistoryQosPolicy_kind

◆ Depth

int Rti.Dds.Core.Policy.HistoryBuilder.Depth
getset

Specifies the number of samples to be kept, when Kind is HistoryKind.KeepLast

The full documentation is available in the C API: DDS_HistoryQosPolicy_depth