TimeBasedFilter Class Reference

Allows a Subscription.DataReader<T> to indicate that it is not interested in all the sample updates that occur within a time period. More...

Inherits IEquatable< TimeBasedFilter >.

Public Member Functions
	TimeBasedFilter (Duration minSeparation)
	Creates a new TimeBasedFilter object using its minimum separation More...
TimeBasedFilter	With (Action< TimeBasedFilterBuilder > build)
	Creates a new TimeBasedFilter 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 (TimeBasedFilter other)
	Compares for equality More...

Properties
Duration	MinimumSeparation [get]
	The minimum separation duration between subsequent samples. More...
static TimeBasedFilter	Default [get]
	Singleton containing the default value of a TimeBasedFilter More...

Detailed Description

Allows a Subscription.DataReader<T> to indicate that it is not interested in all the sample updates that occur within a time period.

The full documentation is available in the C API: DDS_TimeBasedFilterQosPolicy

Constructor & Destructor Documentation

TimeBasedFilter()

TimeBasedFilter

(

Duration

minSeparation

)

Creates a new TimeBasedFilter object using its minimum separation

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

TimeBasedFilter

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

TimeBasedFilter With

(

Action< TimeBasedFilterBuilder >

build

)

Creates a new TimeBasedFilter 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 TimeBasedFilter.

Returns

A new TimeBasedFilter with the changes applied by the Action

Property Documentation

Default

TimeBasedFilter Default

staticget

Singleton containing the default value of a TimeBasedFilter

MinimumSeparation

Duration MinimumSeparation

get

The minimum separation duration between subsequent samples.

The full documentation is available in the C API: DDS_TimeBasedFilterQosPolicy::minimum_separation