DDSKeyedStringDataWriter Class Reference
[KeyedString Built-in Type]

<<interface>> Instantiates DataWriter < DDS_KeyedString >. More...

Inheritance diagram for DDSKeyedStringDataWriter:

List of all members.

Public Member Functions
virtual DDS_InstanceHandle_t	register_instance (const DDS_KeyedString &instance_data)
	Informs RTI Connext that the application will be modifying a particular instance.
virtual DDS_InstanceHandle_t	register_instance (const char *key)
	<<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.
virtual DDS_InstanceHandle_t	register_instance_w_timestamp (const DDS_KeyedString &instance_data, const DDS_Time_t &source_timestamp)
	Performs the same functions as DDSKeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.
virtual DDS_InstanceHandle_t	register_instance_w_timestamp (const char *key, const DDS_Time_t &source_timestamp)
	<<eXtension>> Performs the same functions as DDSKeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	unregister_instance (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle)
	Reverses the action of DDSKeyedStringDataWriter::register_instance.
virtual DDS_ReturnCode_t	unregister_instance (const char *key, const DDS_InstanceHandle_t &handle)
	<<eXtension>> Reverses the action of DDSKeyedStringDataWriter::register_instance.
virtual DDS_ReturnCode_t	unregister_instance_w_timestamp (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	Performs the same function as DDSKeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	unregister_instance_w_timestamp (const char *key, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	write (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle)
	Modifies the value of a DDS_KeyedString data instance.
virtual DDS_ReturnCode_t	write (const char *key, const char *str, const DDS_InstanceHandle_t &handle)
	<<eXtension>> Modifies the value of a DDS_KeyedString data instance.
virtual DDS_ReturnCode_t	write_w_timestamp (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	Performs the same function as DDSKeyedStringDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	write_w_timestamp (const char *key, const char *str, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	write_w_params (const DDS_KeyedString &instance_data, const DDS_WriteParams_t &params)
	Performs the same function as DDSKeyedStringDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
virtual DDS_ReturnCode_t	write_w_params (const char *key, const char *str, const DDS_WriteParams_t &params)
	<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
virtual DDS_ReturnCode_t	dispose (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle)
	Requests the middleware to delete the data.
virtual DDS_ReturnCode_t	dispose (const char *key, const DDS_InstanceHandle_t &instance_handle)
	<<eXtension>> Requests the middleware to delete the data.
virtual DDS_ReturnCode_t	dispose_w_timestamp (const DDS_KeyedString &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	Performs the same functions as DDSKeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.
virtual DDS_ReturnCode_t	dispose_w_timestamp (const char *key, const DDS_InstanceHandle_t &instance_handle, const DDS_Time_t &source_timestamp)
	<<eXtension>> Performs the same functions as DDSKeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.
virtual DDS_ReturnCode_t	get_key_value (DDS_KeyedString &key_holder, const DDS_InstanceHandle_t &handle)
	Retrieve the instance key that corresponds to an instance handle.
virtual DDS_ReturnCode_t	get_key_value (char *key, const DDS_InstanceHandle_t &handle)
	<<eXtension>> Retrieve the instance key that corresponds to an instance handle.
virtual DDS_InstanceHandle_t	lookup_instance (const DDS_KeyedString &key_holder)
	Retrieve the instance handle that corresponds to an instance key_holder.
virtual DDS_InstanceHandle_t	lookup_instance (const char *key)
	<<eXtension>> Retrieve the instance handle that corresponds to an instance key.
Static Public Member Functions
static DDSKeyedStringDataWriter *	narrow (DDSDataWriter *writer)
	Narrow the given DDSDataWriter pointer to a DDSKeyedStringDataWriter pointer.

---

Detailed Description

<<interface>> Instantiates DataWriter < DDS_KeyedString >.

See also:

FooDataWriter

DDSDataWriter

---

Member Function Documentation

static DDSKeyedStringDataWriter* DDSKeyedStringDataWriter::narrow

(

DDSDataWriter *

writer

)

[static]

Narrow the given DDSDataWriter pointer to a DDSKeyedStringDataWriter pointer.

See also:

FooDataWriter::narrow

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::register_instance

(

const DDS_KeyedString &

instance_data

)

[virtual]

Informs RTI Connext that the application will be modifying a particular instance.

See also:

FooDataWriter::register_instance

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::register_instance

(

const char *

key

)

[virtual]

<<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.

See also:

FooDataWriter::register_instance

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::register_instance_w_timestamp	(	const DDS_KeyedString &	instance_data,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

Performs the same functions as DDSKeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.

See also:

FooDataWriter::register_instance_w_timestamp

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::register_instance_w_timestamp	(	const char *	key,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

<<eXtension>> Performs the same functions as DDSKeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.

See also:

FooDataWriter::register_instance_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::unregister_instance	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

Reverses the action of DDSKeyedStringDataWriter::register_instance.

See also:

FooDataWriter::unregister_instance

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::unregister_instance	(	const char *	key,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

<<eXtension>> Reverses the action of DDSKeyedStringDataWriter::register_instance.

See also:

FooDataWriter::unregister_instance

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::unregister_instance_w_timestamp	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

Performs the same function as DDSKeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See also:

FooDataWriter::unregister_instance_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::unregister_instance_w_timestamp	(	const char *	key,
		const DDS_InstanceHandle_t &	handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See also:

FooDataWriter::unregister_instance_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

Modifies the value of a DDS_KeyedString data instance.

See also:

FooDataWriter::write

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write	(	const char *	key,
		const char *	str,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

<<eXtension>> Modifies the value of a DDS_KeyedString data instance.

See also:

FooDataWriter::write

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write_w_timestamp	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

Performs the same function as DDSKeyedStringDataWriter::write except that it also provides the value for the source_timestamp.

See also:

FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write_w_timestamp	(	const char *	key,
		const char *	str,
		const DDS_InstanceHandle_t &	handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::write except that it also provides the value for the source_timestamp.

See also:

FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write_w_params	(	const DDS_KeyedString &	instance_data,
		const DDS_WriteParams_t &	params
	)			[virtual]

Performs the same function as DDSKeyedStringDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

See also:

FooDataWriter::write_w_params

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::write_w_params	(	const char *	key,
		const char *	str,
		const DDS_WriteParams_t &	params
	)			[virtual]

<<eXtension>> Performs the same function as DDSKeyedStringDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

See also:

FooDataWriter::write_w_params

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::dispose	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

Requests the middleware to delete the data.

See also:

FooDataWriter::dispose

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::dispose	(	const char *	key,
		const DDS_InstanceHandle_t &	instance_handle
	)			[virtual]

<<eXtension>> Requests the middleware to delete the data.

See also:

FooDataWriter::dispose

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::dispose_w_timestamp	(	const DDS_KeyedString &	instance_data,
		const DDS_InstanceHandle_t &	handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

Performs the same functions as DDSKeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.

See also:

FooDataWriter::dispose_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::dispose_w_timestamp	(	const char *	key,
		const DDS_InstanceHandle_t &	instance_handle,
		const DDS_Time_t &	source_timestamp
	)			[virtual]

<<eXtension>> Performs the same functions as DDSKeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.

See also:

FooDataWriter::dispose_w_timestamp

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::get_key_value	(	DDS_KeyedString &	key_holder,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

Retrieve the instance key that corresponds to an instance handle.

See also:

FooDataWriter::get_key_value

virtual DDS_ReturnCode_t DDSKeyedStringDataWriter::get_key_value	(	char *	key,
		const DDS_InstanceHandle_t &	handle
	)			[virtual]

<<eXtension>> Retrieve the instance key that corresponds to an instance handle.

See also:

FooDataWriter::get_key_value

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::lookup_instance

(

const DDS_KeyedString &

key_holder

)

[virtual]

Retrieve the instance handle that corresponds to an instance key_holder.

See also:

FooDataWriter::lookup_instance

virtual DDS_InstanceHandle_t DDSKeyedStringDataWriter::lookup_instance

(

const char *

key

)

[virtual]

<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

See also:

FooDataWriter::lookup_instance