net.sf.jrtps.message

Class Data

java.lang.Object

net.sf.jrtps.message.SubMessage

net.sf.jrtps.message.Data

public class Data
extends SubMessage

This Submessage notifies the RTPS Reader of a change to a data-object belonging to the RTPS Writer. The possible changes include both changes in value as well as changes to the lifecycle of the data-object. see 8.3.7.2

Author:

mcr70

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jrtps.message.SubMessage

SubMessage.Kind

Field Summary

Fields

Modifier and Type	Field and Description
static int	KIND

Fields inherited from class net.sf.jrtps.message.SubMessage

header

Constructor Summary

Constructors

Constructor and Description
Data(EntityId readerId, EntityId writerId, long seqNum, ParameterList inlineQosParams, DataEncapsulation dEnc) Constructor for creating a Data message.

Method Summary

Modifier and Type	Method and Description
boolean	dataFlag() Indicates to the Reader that the dataPayload submessage element contains the serialized value of the data-object.
ContentFilterInfo	getContentFilterInfo() Gets the ContentFilterInfo (PID 0x0055) inline qos parameter if present.
DataEncapsulation	getDataEncapsulation() Gets the DataEncapsulation.
short	getExtraFlags()
ParameterList	getInlineQos() Gets the inlineQos parameters if present.
EntityId	getReaderId() Identifies the RTPS Reader entity that is being informed of the change to the data-object.
StatusInfo	getStatusInfo() Get the StatusInfo (PID 0x0071) inline QoS parameter if it is present.
EntityId	getWriterId() Identifies the RTPS Writer entity that made the change to the data-object.
long	getWriterSequenceNumber() Uniquely identifies the change and the relative order for all changes made by the RTPS Writer identified by the writerGuid.
boolean	inlineQosFlag() Indicates to the Reader the presence of a ParameterList containing QoS parameters that should be used to interpret the message.
boolean	keyFlag() Indicates to the Reader that the dataPayload submessage element contains the serialized value of the key of the data-object.
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this SubMessage into given RTPSByteBuffer.

Methods inherited from class net.sf.jrtps.message.SubMessage

getHeader, getKind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KIND

public static final int KIND

See Also:

Constant Field Values

Constructor Detail

Data

public Data(EntityId readerId,
            EntityId writerId,
            long seqNum,
            ParameterList inlineQosParams,
            DataEncapsulation dEnc)

Constructor for creating a Data message.

Parameters:

readerId - EntityId of the reader

writerId - EntityId of the writer

seqNum - Sequence number of the Data submessage

inlineQosParams - Inline QoS parameters. May be null.

dEnc - If null, neither dataFlag or keyFlag is set

Method Detail

inlineQosFlag

public boolean inlineQosFlag()

Indicates to the Reader the presence of a ParameterList containing QoS parameters that should be used to interpret the message.

Returns:

true, if inlineQos flag is set

getInlineQos

public ParameterList getInlineQos()

Gets the inlineQos parameters if present. Inline QoS parameters are present, if inlineQosFlag() returns true.

Returns:

InlineQos parameters, or null if not present

See Also:

inlineQosFlag()

dataFlag

public boolean dataFlag()

Indicates to the Reader that the dataPayload submessage element contains the serialized value of the data-object.

Returns:

true, data flag is set

keyFlag

public boolean keyFlag()

Indicates to the Reader that the dataPayload submessage element contains the serialized value of the key of the data-object.

Returns:

true, if key flag is set

getReaderId

public EntityId getReaderId()

Identifies the RTPS Reader entity that is being informed of the change to the data-object.

Returns:

EntityId_t of the reader

getWriterId

public EntityId getWriterId()

Identifies the RTPS Writer entity that made the change to the data-object.

Returns:

EntityId_t of the writer

getWriterSequenceNumber

public long getWriterSequenceNumber()

Uniquely identifies the change and the relative order for all changes made by the RTPS Writer identified by the writerGuid. Each change gets a consecutive sequence number. Each RTPS Writer maintains is own sequence number.

Returns:

sequence number

getExtraFlags

public short getExtraFlags()

writeTo

public void writeTo(RTPSByteBuffer bb)

Description copied from class: SubMessage

Writes this SubMessage into given RTPSByteBuffer.

Specified by:

writeTo in class SubMessage

Parameters:

bb - RTPSByteBuffer

getDataEncapsulation

public DataEncapsulation getDataEncapsulation()

Gets the DataEncapsulation.

Returns:

DataEncapsulation

getStatusInfo

public StatusInfo getStatusInfo()

Get the StatusInfo (PID 0x0071) inline QoS parameter if it is present. If inline Qos is not present, an empty(default) StatusInfo is returned

Returns:

StatusInfo

getContentFilterInfo

public ContentFilterInfo getContentFilterInfo()

Gets the ContentFilterInfo (PID 0x0055) inline qos parameter if present.

Returns:

ContentFilterInfo, or null if one was not present

toString

public String toString()

Overrides:

toString in class SubMessage