Rti.Dds.Core.Policy.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()

Rti.Dds.Core.Policy.TimeBasedFilter.TimeBasedFilter

(

Duration

minSeparation

)

Creates a new TimeBasedFilter object using its minimum separation

Member Function Documentation

With()

TimeBasedFilter Rti.Dds.Core.Policy.TimeBasedFilter.With ( Action< TimeBasedFilterBuilder >  build )

inline

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

GetHashCode()

override int Rti.Dds.Core.Policy.TimeBasedFilter.GetHashCode ( )

inline

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Policy.TimeBasedFilter.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Policy.TimeBasedFilter.Equals ( TimeBasedFilter  other )

inline

Compares for equality

Property Documentation

MinimumSeparation

Duration Rti.Dds.Core.Policy.TimeBasedFilter.MinimumSeparation

get

The minimum separation duration between subsequent samples.

The full documentation is available in the C API: DDS_TimeBasedFilterQosPolicy_minimum_separation

Default

TimeBasedFilter Rti.Dds.Core.Policy.TimeBasedFilter.Default

staticget

Singleton containing the default value of a TimeBasedFilter