Rti.Dds.Core.SampleIdentity Struct Reference

Uniquely identifies a data sample within a DDS domain and a Topic. More...

Inherits IEquatable< SampleIdentity >, and IComparable< SampleIdentity >.

Public Member Functions
	SampleIdentity (in Guid writerGuid, long sequenceNumber)
	Creates a SampleIdentity with its two components More...
int	CompareTo (SampleIdentity other)
	Compares two objects. More...
bool	Equals (SampleIdentity other)
	Compares two objects. More...
override bool	Equals (object obj)
	Compares two objects. More...
override int	GetHashCode ()
	Gets the hash code. More...
override string	ToString ()
	Converts to a readable string. More...

Properties
Guid	WriterGuid [get]
	Identifies the data source. More...
long	SequenceNumber [get]
	The monotonically increasing 64-bit sequence number that identifies the sample in the data source. More...
static SampleIdentity	Unknown [get]
	Special value that indicates that the identity is unknown. More...
static SampleIdentity	Auto [get]
	Special value to indicate that a writer will automatically assign the identity of the sample in Publication.DataWriter<T>.Write(T, Publication.WriteParams) More...

Detailed Description

Uniquely identifies a data sample within a DDS domain and a Topic.

Constructor & Destructor Documentation

SampleIdentity()

Rti.Dds.Core.SampleIdentity.SampleIdentity ( in Guid  writerGuid, long  sequenceNumber  )

inline

Creates a SampleIdentity with its two components

Member Function Documentation

CompareTo()

int Rti.Dds.Core.SampleIdentity.CompareTo

(

SampleIdentity

other

)

Compares two objects.

Equals() [1/2]

bool Rti.Dds.Core.SampleIdentity.Equals

(

SampleIdentity

other

)

Compares two objects.

Equals() [2/2]

override bool Rti.Dds.Core.SampleIdentity.Equals

(

object

obj

)

Compares two objects.

GetHashCode()

override int Rti.Dds.Core.SampleIdentity.GetHashCode

(

)

Gets the hash code.

ToString()

override string Rti.Dds.Core.SampleIdentity.ToString

(

)

Converts to a readable string.

Property Documentation

WriterGuid

Guid Rti.Dds.Core.SampleIdentity.WriterGuid

get

Identifies the data source.

SequenceNumber

long Rti.Dds.Core.SampleIdentity.SequenceNumber

get

The monotonically increasing 64-bit sequence number that identifies the sample in the data source.

Unknown

SampleIdentity Rti.Dds.Core.SampleIdentity.Unknown

staticget

Initial value:

=
            new SampleIdentity(Guid.Unknown, Core.SequenceNumber.Unknown)

Special value that indicates that the identity is unknown.

Auto

SampleIdentity Rti.Dds.Core.SampleIdentity.Auto

staticget

Initial value:

=
            new SampleIdentity(Guid.Auto, Core.SequenceNumber.Auto)

Special value to indicate that a writer will automatically assign the identity of the sample in Publication.DataWriter<T>.Write(T, Publication.WriteParams)