Rti.Dds.Publication.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 = false [get, set]
	Allows retrieving the actual value of those fields that were automatic More...
SampleIdentity	Identity = SampleIdentity.Auto [get, set]
	Identity of the sample. More...
SampleIdentity	RelatedSampleIdentity = SampleIdentity.Unknown [get, set]
	The identity of another sample related to this one More...
Time	SourceTimestamp = Time.Invalid [get, set]
	Source timestamp upon write More...
Cookie	Cookie = Cookie.Empty [get, set]
	Octet sequence identifying written data sample More...
InstanceHandle	InstanceHandle = InstanceHandle.Nil [get, set]
	Instance handle More...
int	Priority = Core.Priority.Undefined [get, set]
	Publication priority More...
int	Flag = 0 [get, set]
	Flags associated with the sample. More...
Core.Guid	SourceGuid = Core.Guid.Auto [get, set]
	Identifies the application logical data source associated with the sample being written. More...
Core.Guid	RelatedSourceGuid = Core.Guid.Unknown [get, set]
	Identifies the application logical data source that is related to the sample being written. More...
Core.Guid	RelatedReaderGuid = Core.Guid.Unknown [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]

bool Rti.Dds.Publication.WriteParams.Equals

(

WriteParams

other

)

Compares for equality

Equals() [2/2]

override bool Rti.Dds.Publication.WriteParams.Equals

(

object

obj

)

Compares for equality

GetHashCode()

override int Rti.Dds.Publication.WriteParams.GetHashCode ( )

inline

Gets the hash code

Property Documentation

ReplaceAuto

bool Rti.Dds.Publication.WriteParams.ReplaceAuto = false

getset

Allows retrieving the actual value of those fields that were automatic

The full documentation is available in the C API: DDSWriteParams_t_replace_auto

Identity

SampleIdentity Rti.Dds.Publication.WriteParams.Identity = SampleIdentity.Auto

getset

Identity of the sample.

The full documentation is available in the C API: DDSWriteParams_t_identity

RelatedSampleIdentity

SampleIdentity Rti.Dds.Publication.WriteParams.RelatedSampleIdentity = SampleIdentity.Unknown

getset

The identity of another sample related to this one

The full documentation is available in the C API: DDSWriteParams_t_related_sample_identity

SourceTimestamp

Time Rti.Dds.Publication.WriteParams.SourceTimestamp = Time.Invalid

getset

Source timestamp upon write

The full documentation is available in the C API: DDSWriteParams_t_source_timestamp

Cookie

Cookie Rti.Dds.Publication.WriteParams.Cookie = Cookie.Empty

getset

Octet sequence identifying written data sample

The full documentation is available in the C API: DDSWriteParams_t_cookie

InstanceHandle

InstanceHandle Rti.Dds.Publication.WriteParams.InstanceHandle = InstanceHandle.Nil

getset

Instance handle

The full documentation is available in the C API: DDSWriteParams_t_handle

Priority

int Rti.Dds.Publication.WriteParams.Priority = Core.Priority.Undefined

getset

Publication priority

See also

Rti.Dds.Core.Priority for special values

The full documentation is available in the C API: DDSWriteParams_t_priority

Flag

int Rti.Dds.Publication.WriteParams.Flag = 0

getset

Flags associated with the sample.

The full documentation is available in the C API: DDSWriteParams_tflag

SourceGuid

Core.Guid Rti.Dds.Publication.WriteParams.SourceGuid = Core.Guid.Auto

getset

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

The full documentation is available in the C API: DDSWriteParams_t_source_guid

RelatedSourceGuid

Core.Guid Rti.Dds.Publication.WriteParams.RelatedSourceGuid = Core.Guid.Unknown

getset

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

The full documentation is available in the C API: DDSWriteParams_t_related_source_guid

RelatedReaderGuid

Core.Guid Rti.Dds.Publication.WriteParams.RelatedReaderGuid = Core.Guid.Unknown

getset

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

The full documentation is available in the C API: DDSWriteParams_t_related_reader_guid