net.sf.jrtps.message.parameter

Class QosTimeBasedFilter

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosTimeBasedFilter

All Implemented Interfaces:

Changeable, DataReaderPolicy<QosTimeBasedFilter>, QosPolicy<QosTimeBasedFilter>

public class QosTimeBasedFilter
extends Parameter
implements DataReaderPolicy<QosTimeBasedFilter>, Changeable

QosTimeBasedFilter. This policy must be consistent with QosDeadline, so that period ≤ minimum_separation.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
QosTimeBasedFilter(Duration minimum_separation)
QosTimeBasedFilter(long millis) Constructs QosTimeBasedFilter.

Method Summary

Modifier and Type	Method and Description
static QosTimeBasedFilter	defaultTimeBasedFilter() Get the default QosTimeBasedFilter: 0,0
Duration	getMinimumSeparation() Get the minimum separation.
boolean	isCompatible(QosTimeBasedFilter 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

QosTimeBasedFilter

public QosTimeBasedFilter(Duration minimum_separation)

QosTimeBasedFilter

public QosTimeBasedFilter(long millis)

Constructs QosTimeBasedFilter.

Parameters:

millis - minimum_separation as milliseconds

Method Detail

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

getMinimumSeparation

public Duration getMinimumSeparation()

Get the minimum separation.

Returns:

minimum separation

isCompatible

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

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultTimeBasedFilter

public static QosTimeBasedFilter defaultTimeBasedFilter()

Get the default QosTimeBasedFilter: 0,0

Returns:

default QosTimeBasedFilter

toString

public String toString()

Overrides:

toString in class Parameter