WriteParams_t Class Reference

<<eXtension>> Input parameters for writing with com.rti.dds.topic.example.FooDataWriter.write_w_params, com.rti.dds.topic.example.FooDataWriter.dispose_w_params, com.rti.dds.topic.example.FooDataWriter.register_instance_w_params, com.rti.dds.topic.example.FooDataWriter.unregister_instance_w_params More...

Inherits Struct.

List of all members.

Public Member Functions
	WriteParams_t ()
	Construct a new WriteParams_t.
	WriteParams_t (SampleIdentity_t identity, Time_t source_timestamp, Cookie_t cookie, InstanceHandle_t handle)
	Construct a new WriteParams_t with the given members.
Public Attributes
final SampleIdentity_t	identity
	Identity of the sample.
final Time_t	source_timestamp
	Source timestamp upon write.
final Cookie_t	cookie = new Cookie_t()
	Octet sequence identifying written data sample.
final InstanceHandle_t	handle = InstanceHandle_t.HANDLE_NIL
	Instance handle.

---

Detailed Description

<<eXtension>> Input parameters for writing with com.rti.dds.topic.example.FooDataWriter.write_w_params, com.rti.dds.topic.example.FooDataWriter.dispose_w_params, com.rti.dds.topic.example.FooDataWriter.register_instance_w_params, com.rti.dds.topic.example.FooDataWriter.unregister_instance_w_params

---

Constructor & Destructor Documentation

WriteParams_t

(

)

Construct a new WriteParams_t.

WriteParams_t	(	SampleIdentity_t	identity,
		Time_t	source_timestamp,
		Cookie_t	cookie,
		InstanceHandle_t	handle
	)

Construct a new WriteParams_t with the given members.

---

Member Data Documentation

final SampleIdentity_t identity

Initial value:

        new SampleIdentity_t(SampleIdentity_t.AUTO_SAMPLE_IDENTITY)

Identity of the sample.

Identifies the sample being written. The identity consist of a pair (Vitual Writer GUID, SequenceNumber).

Use the default value to let RTI Connext determine the sample identity as follows:

• The Virtual Writer GUID is the virtual GUID associated with the writer writing the sample. This virtual GUID is configured using com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.virtual_guid.

• The sequence number is increased by one with respect to the previous value.

The virtual sequence numbers for a virtual writer must be strictly monotonically increasing. If you try to write a sample with a sequence number smaller or equal to the last sequence number, the write operation will fail.

[default] SampleIdentity_t.AUTO_SAMPLE_IDENTITY.

final Time_t source_timestamp

Initial value:

 
        new Time_t(Time_t.TIME_INVALID_SEC, Time_t.TIME_INVALID_NSEC)

Source timestamp upon write.

Specifies the source timestamp that will be available to the com.rti.dds.subscription.DataReader objects by means of the source_timestamp attribute within the com.rti.dds.subscription.SampleInfo.

[default] com.rti.dds.infrastructure.Time_t.INVALID.

final Cookie_t cookie = new Cookie_t()

Octet sequence identifying written data sample.

The maximum size of the cookie is configurable using the field com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.cookie_max_length.

[default] Empty sequence (zero-length).

final InstanceHandle_t handle = InstanceHandle_t.HANDLE_NIL

Instance handle.

Either the handle returned by a previous call to com.rti.dds.topic.example.FooDataWriter.register_instance, or else the special value InstanceHandle_t.HANDLE_NIL.

[default] InstanceHandle_t.HANDLE_NIL