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()

SampleIdentity	(	in Guid	writerGuid,
		long	sequenceNumber
	)

Creates a SampleIdentity with its two components

Member Function Documentation

CompareTo()

int CompareTo

(

SampleIdentity

other

)

Compares two objects.

Equals() [1/2]

override bool Equals

(

object

obj

)

Compares two objects.

Equals() [2/2]

bool Equals

(

SampleIdentity

other

)

Compares two objects.

GetHashCode()

override int GetHashCode

(

)

Gets the hash code.

ToString()

override string ToString

(

)

Converts to a readable string.

Property Documentation

Auto

SampleIdentity Auto

staticget

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

SequenceNumber

long SequenceNumber

get

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

Unknown

SampleIdentity Unknown

staticget

Special value that indicates that the identity is unknown.

WriterGuid

Guid WriterGuid

get

Identifies the data source.