net.sf.jrtps.message.parameter

Class QosUserData

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosUserData

All Implemented Interfaces:

Changeable, DataReaderPolicy<QosUserData>, DataWriterPolicy<QosUserData>, QosPolicy<QosUserData>

public class QosUserData
extends Parameter
implements DataReaderPolicy<QosUserData>, DataWriterPolicy<QosUserData>, Changeable

UserData QoS policy allows passing an arbitrary byte array to remote entities.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
QosUserData(byte[] userData)

Method Summary

Modifier and Type	Method and Description
static QosUserData	defaultUserData()
byte[]	getUserData() Gets the user data
boolean	isCompatible(QosUserData other) Checks, if this QosPolicy is compatible with other QosPolicy.
void	read(RTPSByteBuffer bb, int length)
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this Parameter into given RTPSByteBuffer

Methods inherited from class net.sf.jrtps.message.parameter.Parameter

getBytes, getParameterId, readBytes, writeBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

QosUserData

public QosUserData(byte[] userData)

Method Detail

getUserData

public byte[] getUserData()

Gets the user data

Returns:

user data

read

public void read(RTPSByteBuffer bb,
                 int length)

Specified by:

read in class Parameter

writeTo

public void writeTo(RTPSByteBuffer bb)

Description copied from class: Parameter

Writes this Parameter into given RTPSByteBuffer

Specified by:

writeTo in class Parameter

Parameters:

bb - RTPSByteBuffer

isCompatible

public boolean isCompatible(QosUserData other)

Description copied from interface: QosPolicy

Checks, if this QosPolicy is compatible with other QosPolicy. 'this' QosPolicy should be considered as 'offered' policy, and 'other' should be considered as 'requested' policy.

Specified by:

isCompatible in interface QosPolicy<QosUserData>

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultUserData

public static QosUserData defaultUserData()

toString

public String toString()

Overrides:

toString in class Parameter