RTI Connext C# API  6.1.0
DataState Class Reference

Information about a sample's SampleState, ViewState, and InstanceState. More...

Inherits IEquatable< DataState >.

Public Member Functions

DataState And (SampleState s)
 Creates a copy of this DataState with a new SampleState. More...
 
DataState And (ViewState s)
 Creates a copy of this DataState with a new ViewState. More...
 
DataState And (InstanceState s)
 Creates a copy of this DataState with a new InstanceState. More...
 
void Deconstruct (out SampleState sample, out ViewState view, out InstanceState instance)
 Deconstruct operation that allows unpacking a DataState into its three values: SampleState, ViewState and InstanceState. More...
 
bool Equals (DataState other)
 Equality comparison More...
 
override bool Equals (object obj)
 Equality comparison More...
 
override int GetHashCode ()
 Get the hash code More...
 
override string ToString ()
 Print the three states More...
 

Static Public Member Functions

static DataState With (SampleState s)
 Creates a DataState with a specific SampleState. More...
 
static DataState With (ViewState s)
 Creates a DataState with a specific ViewState More...
 
static DataState With (InstanceState s)
 Creates a DataState with a specific InstanceState. More...
 
static DataState With (SampleState sample=SampleState.Any, ViewState view=ViewState.Any, InstanceState instance=InstanceState.Any)
 Creates a DataState with specific SampleState, ViewState, and InstanceState. More...
 
static implicit operator DataState (SampleState s)
 Implicit conversion from SampleState to DataState. More...
 
static implicit operator DataState (ViewState s)
 Implicit conversion from ViewState to DataState. More...
 
static implicit operator DataState (InstanceState s)
 Implicit conversion from InstanceState to DataState. More...
 
static implicit operator DataState ((SampleState sample, ViewState view, InstanceState instance) tuple)
 Implicit conversion from a tuple with the three states. More...
 

Properties

SampleState Sample [get]
 Gets the SampleState More...
 
ViewState View [get]
 Gets the ViewState. More...
 
InstanceState Instance [get]
 Gets the InstanceState. More...
 
static DataState Any [get]
 A constant representing any sample, view or instance states. More...
 

Detailed Description

Information about a sample's SampleState, ViewState, and InstanceState.

Member Function Documentation

◆ And() [1/3]

Creates a copy of this DataState with a new InstanceState.

◆ And() [2/3]

DataState And ( SampleState  s)

Creates a copy of this DataState with a new SampleState.

◆ And() [3/3]

DataState And ( ViewState  s)

Creates a copy of this DataState with a new ViewState.

◆ Deconstruct()

void Deconstruct ( out SampleState  sample,
out ViewState  view,
out InstanceState  instance 
)

Deconstruct operation that allows unpacking a DataState into its three values: SampleState, ViewState and InstanceState.

◆ Equals() [1/2]

bool Equals ( DataState  other)

Equality comparison

◆ Equals() [2/2]

override bool Equals ( object  obj)

Equality comparison

◆ GetHashCode()

override int GetHashCode ( )

Get the hash code

◆ operator DataState() [1/4]

static implicit operator DataState ( (SampleState sample, ViewState view, InstanceState instance)  tuple)
static

Implicit conversion from a tuple with the three states.

◆ operator DataState() [2/4]

static implicit operator DataState ( InstanceState  s)
static

Implicit conversion from InstanceState to DataState.

◆ operator DataState() [3/4]

static implicit operator DataState ( SampleState  s)
static

Implicit conversion from SampleState to DataState.

◆ operator DataState() [4/4]

static implicit operator DataState ( ViewState  s)
static

Implicit conversion from ViewState to DataState.

◆ ToString()

override string ToString ( )

Print the three states

◆ With() [1/4]

static DataState With ( InstanceState  s)
static

Creates a DataState with a specific InstanceState.

◆ With() [2/4]

static DataState With ( SampleState  s)
static

Creates a DataState with a specific SampleState.

◆ With() [3/4]

static DataState With ( SampleState  sample = SampleState.Any,
ViewState  view = ViewState.Any,
InstanceState  instance = InstanceState.Any 
)
static

Creates a DataState with specific SampleState, ViewState, and InstanceState.

◆ With() [4/4]

static DataState With ( ViewState  s)
static

Creates a DataState with a specific ViewState

Property Documentation

◆ Any

DataState Any
staticget

A constant representing any sample, view or instance states.

◆ Instance

InstanceState Instance
get

Gets the InstanceState.

◆ Sample

SampleState Sample
get

Gets the SampleState

◆ View

ViewState View
get

Gets the ViewState.