net.sf.jrtps.message.parameter

Class QosHistory

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosHistory

All Implemented Interfaces:

DataReaderPolicy<QosHistory>, DataWriterPolicy<QosHistory>, QosPolicy<QosHistory>, TopicPolicy<QosHistory>

public class QosHistory
extends Parameter
implements DataReaderPolicy<QosHistory>, TopicPolicy<QosHistory>, DataWriterPolicy<QosHistory>

QosHistory. This policy must be consistent with QosResourceLimits, so that HISTORY.depth ≤ RESOURCE_LIMITS.max_samples_per_instance

Author:

mcr70

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QosHistory.Kind

Constructor Summary

Constructors

Constructor and Description
QosHistory(int depth) Constructs QosHistory with kind KEEP_LAST and given depth
QosHistory(QosHistory.Kind kind, int depth) Constructs QosHistory given kind and depth

Method Summary

Modifier and Type	Method and Description
static QosHistory	defaultHistory() Get the default QosHistory: KEEP_LAST, 1
int	getDepth() Get the depth of this QosHistory.
QosHistory.Kind	getKind()
boolean	isCompatible(QosHistory 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

QosHistory

public QosHistory(int depth)

Constructs QosHistory with kind KEEP_LAST and given depth

Parameters:

depth - Depth of history

QosHistory

public QosHistory(QosHistory.Kind kind,
                  int depth)

Constructs QosHistory given kind and depth

Parameters:

kind - KEEP_LAST or KEEP_ALL

depth - depth of history

Method Detail

getDepth

public int getDepth()

Get the depth of this QosHistory. Depth 1 means that only latest sample is kept.

Returns:

depth

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

getKind

public QosHistory.Kind getKind()

isCompatible

public boolean isCompatible(QosHistory 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<QosHistory>

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultHistory

public static QosHistory defaultHistory()

Get the default QosHistory: KEEP_LAST, 1

Returns:

default QosHistory

toString

public String toString()

Overrides:

toString in class Parameter