DataRepresentationQosPolicy Class Reference

This QoS policy contains a list of representation identifiers used by com.rti.dds.publication.DataWriter and com.rti.dds.subscription.DataReader entities to negotiate which data representation to use. More...

Inheritance diagram for DataRepresentationQosPolicy:

Public Attributes
final ShortSeq	value = new ShortSeq()
	Sequence of representation identifiers.
Public Attributes inherited from QosPolicy
final QosPolicyId_t	id
	The ID of this QoS policy.
final String	policy_name
	The name of this QoS policy.

Static Public Attributes
static final short	XCDR_DATA_REPRESENTATION = 0
	Corresponds to the Extended Common Data Representation encoding version 1.
static final short	XML_DATA_REPRESENTATION = 1
	Corresponds to the XML Data Representation (unsupported).
static final short	XCDR2_DATA_REPRESENTATION = 2
	Corresponds to the Extended Common Data Representation encoding version 2.
static final short	AUTO_DATA_REPRESENTATION = -1
	Representation is automatically chosen based on the type.

Additional Inherited Members
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)
abstract int	hashCode ()
String	toString ()
Protected Member Functions inherited from Struct
	Struct ()
abstract void	pull_from_nativeI (long native_status)
abstract void	push_to_nativeI (long native_status)

Detailed Description

This QoS policy contains a list of representation identifiers used by com.rti.dds.publication.DataWriter and com.rti.dds.subscription.DataReader entities to negotiate which data representation to use.

Entity:

com.rti.dds.topic.Topic, com.rti.dds.subscription.DataReader, com.rti.dds.publication.DataWriter

Status:

com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_INCOMPATIBLE_QOS_STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED_INCOMPATIBLE_QOS_STATUS

Properties:

RxO = YES
Changeable = UNTIL ENABLE

See Also

DATA_REPRESENTATION

This policy has request-offer semantics. A com.rti.dds.publication.DataWriter may only offer a single representation. Attempting to put multiple representations in a com.rti.dds.publication.DataWriter will result in com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY. A com.rti.dds.publication.DataWriter will use its offered policy to communicate with its matched com.rti.dds.subscription.DataReader entities. A com.rti.dds.subscription.DataReader requests one or more representations. If a com.rti.dds.publication.DataWriter offers a representation that is contained within the sequence of the com.rti.dds.subscription.DataReader, the offer satisfies the request and the policies are compatible. Otherwise, they are incompatible.

When representations are specified in the com.rti.dds.topic.TopicQos, com.rti.dds.publication.Publisher.copy_from_topic_qos copies the first element of the sequence, and com.rti.dds.subscription.Subscriber.copy_from_topic_qos copies the whole sequence.

Member Data Documentation

final ShortSeq value = new ShortSeq()

Sequence of representation identifiers.

[default] For com.rti.dds.topic.Topic, com.rti.dds.publication.DataWriter, and com.rti.dds.subscription.DataReader, a list with one element: com.rti.dds.infrastructure.DataRepresentationQosPolicy.AUTO_DATA_REPRESENTATION.

Note

An empty sequence is equivalent to a list with one element: com.rti.dds.infrastructure.DataRepresentationQosPolicy.XCDR_DATA_REPRESENTATION.