net.sf.jrtps.message.parameter

Class QosResourceLimits

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

net.sf.jrtps.message.parameter.QosResourceLimits

All Implemented Interfaces:

DataReaderPolicy<QosResourceLimits>, DataWriterPolicy<QosResourceLimits>, QosPolicy<QosResourceLimits>, TopicPolicy<QosResourceLimits>

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

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

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
QosResourceLimits(int max_samples, int max_instances, int max_samples_per_instance) Constructs QosResourceLimits.

Method Summary

Modifier and Type	Method and Description
static QosResourceLimits	defaultResourceLimits() Get the default QosResouceLimits: LENGTH_UNLIMITED, LENGTH_UNLIMITED, LENGTH_UNLIMITED
int	getMaxInstances() Get max_instances
int	getMaxSamples() Get max_samples
int	getMaxSamplesPerInstance() Get max_samples_per_instance
boolean	isCompatible(QosResourceLimits 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

QosResourceLimits

public QosResourceLimits(int max_samples,
                         int max_instances,
                         int max_samples_per_instance)

Constructs QosResourceLimits. A value of -1 indicates a given resource constraint is disabled.

Parameters:

max_samples - Maximum number of total samples allowed

max_instances - Maximum number of instances allowed

max_samples_per_instance - Maximum number of samples per instance allowed

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

getMaxSamples

public int getMaxSamples()

Get max_samples

Returns:

max_samples

getMaxInstances

public int getMaxInstances()

Get max_instances

Returns:

max_instances

getMaxSamplesPerInstance

public int getMaxSamplesPerInstance()

Get max_samples_per_instance

Returns:

max_samples_per_instance

isCompatible

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

Parameters:

other - Requested QosPolicy

Returns:

true, if QosPolicy is compatible

defaultResourceLimits

public static QosResourceLimits defaultResourceLimits()

Get the default QosResouceLimits: LENGTH_UNLIMITED, LENGTH_UNLIMITED, LENGTH_UNLIMITED

Returns:

default QosResouceLimits

toString

public String toString()

Overrides:

toString in class Parameter