WriteParams Class Reference

Additional parameters for the DataWriter<T> operations that write data or dispose, register or unregister an instance. More...

Inherits IEquatable< WriteParams >.

Public Member Functions
bool	Equals (WriteParams other)
	Compares for equality More...
override bool	Equals (object obj)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code More...

Properties
bool	ReplaceAuto [get, set]
	Allows retrieving the actual value of those fields that were automatic More...
SampleIdentity	Identity [get, set]
	Identity of the sample. More...
SampleIdentity	RelatedSampleIdentity [get, set]
	The identity of another sample related to this one More...
Time	SourceTimestamp [get, set]
	Source timestamp upon write More...
Cookie	Cookie [get, set]
	Octet sequence identifying written data sample More...
InstanceHandle	InstanceHandle [get, set]
	Instance handle More...
int	Priority [get, set]
	Publication priority More...
int	Flag [get, set]
	Flags associated with the sample. More...
Core.Guid	SourceGuid [get, set]
	Identifies the application logical data source associated with the sample being written. More...
Core.Guid	RelatedSourceGuid [get, set]
	Identifies the application logical data source that is related to the sample being written. More...
Core.Guid	RelatedReaderGuid [get, set]
	Identifies a DataReader that is logically related to the sample that is being written. More...

Detailed Description

Additional parameters for the DataWriter<T> operations that write data or dispose, register or unregister an instance.

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

obj

)

Compares for equality

Equals() [2/2]

bool Equals

(

WriteParams

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

Property Documentation

Cookie

Cookie Cookie

getset

Octet sequence identifying written data sample

The full documentation is available in the C API: DDS_WriteParams_t::cookie

Flag

int Flag

getset

Flags associated with the sample.

The full documentation is available in the C API: DDS_WriteParams_t::flag

Identity

SampleIdentity Identity

getset

Identity of the sample.

The full documentation is available in the C API: DDS_WriteParams_t::identity

InstanceHandle

InstanceHandle InstanceHandle

getset

Instance handle

The full documentation is available in the C API: DDS_WriteParams_t::handle

Priority

int Priority

getset

Publication priority

See also

Rti.Dds.Core.Priority for special values

The full documentation is available in the C API: DDS_WriteParams_t::priority

RelatedReaderGuid

Core.Guid RelatedReaderGuid

getset

Identifies a DataReader that is logically related to the sample that is being written.

The full documentation is available in the C API: DDS_WriteParams_t::related_reader_guid

RelatedSampleIdentity

SampleIdentity RelatedSampleIdentity

getset

The identity of another sample related to this one

The full documentation is available in the C API: DDS_WriteParams_t::related_sample_identity

RelatedSourceGuid

Core.Guid RelatedSourceGuid

getset

Identifies the application logical data source that is related to the sample being written.

The full documentation is available in the C API: DDS_WriteParams_t::related_source_guid

ReplaceAuto

bool ReplaceAuto

getset

Allows retrieving the actual value of those fields that were automatic

The full documentation is available in the C API: DDS_WriteParams_t::replace_auto

SourceGuid

Core.Guid SourceGuid

getset

Identifies the application logical data source associated with the sample being written.

The full documentation is available in the C API: DDS_WriteParams_t::source_guid

SourceTimestamp

Time SourceTimestamp

getset

Source timestamp upon write

The full documentation is available in the C API: DDS_WriteParams_t::source_timestamp