WaitSetProperty Class Reference

Specifies how a WaitSet behaves when multiple conditions are triggered. More...

Inherits IEquatable< WaitSetProperty >.

Public Member Functions
	WaitSetProperty (int maxEventCount, Duration maxEventDelay)
	Creates a new WaitSetProperty with the given parameters More...
WaitSetProperty	With (Action< WaitSetPropertyBuilder > build)
	Creates a new WaitSetProperty 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 (WaitSetProperty other)
	Compares for equality More...

Properties
int	MaxEventCount [get]
	Maximum number of trigger events to cause a WaitSet to awaken. More...
Duration	MaxEventDelay [get]
	Maximum delay from occurrence of first trigger event to cause a WaitSet to awaken. More...
static WaitSetProperty	Default [get]
	Singleton containing the default value of a WaitSetProperty More...

Detailed Description

Specifies how a WaitSet behaves when multiple conditions are triggered.

Constructor & Destructor Documentation

WaitSetProperty()

WaitSetProperty	(	int	maxEventCount,
		Duration	maxEventDelay
	)

Creates a new WaitSetProperty with the given parameters

Parameters

maxEventCount	The value for MaxEventCount
maxEventDelay	The value for MaxEventDelay

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

WaitSetProperty

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

WaitSetProperty With

(

Action< WaitSetPropertyBuilder >

build

)

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

Returns

A new WaitSetProperty with the changes applied by the Action

Property Documentation

Default

WaitSetProperty Default

staticget

Singleton containing the default value of a WaitSetProperty

MaxEventCount

int MaxEventCount

get

Maximum number of trigger events to cause a WaitSet to awaken.

The full documentation is available in the C API: DDS_WaitSetProperty_t::max_event_count

MaxEventDelay

Duration MaxEventDelay

get

Maximum delay from occurrence of first trigger event to cause a WaitSet to awaken.

The full documentation is available in the C API: DDS_WaitSetProperty_t::max_event_delay