History Class Reference

Specifies the middleware behavior in the case where the value of a sample changes (one or more times) before it can be successfully communicated to one or more existing subscribers. More...

Inherits IEquatable< History >.

Public Member Functions
	History (HistoryKind kind, int depth=1)
	Creates a new instance More...
History	With (Action< HistoryBuilder > build)
	Creates a new History with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (History other)
	Compares for equality More...

Properties
HistoryKind	Kind [get]
	Specifies the kind of history to be kept. More...
int	Depth [get]
	Specifies the number of samples to be kept, when Kind is HistoryKind.KeepLast More...
static History	Default [get]
	Singleton containing the default value of a History More...

Detailed Description

Specifies the middleware behavior in the case where the value of a sample changes (one or more times) before it can be successfully communicated to one or more existing subscribers.

Constructor & Destructor Documentation

History()

History	(	HistoryKind	kind,
		int	depth = 1
	)

Creates a new instance

Parameters

kind	The value for Kind
depth	The value for Depth

Member Function Documentation

Equals() [1/2]

bool Equals

(

History

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

History With

(

Action< HistoryBuilder >

build

)

Creates a new History with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this History.

Returns

A new History with the changes applied by the Action

Property Documentation

Default

History Default

staticget

Singleton containing the default value of a History

Depth

int Depth

get

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

Kind

HistoryKind Kind

get

Specifies the kind of history to be kept.

The full documentation is available in the C API: DDS_HistoryQosPolicy::kind