net.sf.jrtps.rtps

Class Sample<T>

java.lang.Object

net.sf.jrtps.rtps.Sample<T>

Type Parameters:

T - Type of Sample

All Implemented Interfaces:

Cloneable

public class Sample<T>
extends Object
implements Cloneable

Represents a sample of type T.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
Sample(Guid writerGuid, Marshaller<T> m, long seqNum, long timestamp, ChangeKind kind, T obj) This constructor is used when adding Sample to UDDSWriterCache.
Sample(Guid writerGuid, Marshaller<T> m, long seqNum, long timestamp, long sourceTimestamp, Data data) This constructor is used when adding Sample to UDDSReaderCache.
Sample(long seqNum) This constructor is used to create a Sample, that has no content.

Method Summary

Modifier and Type	Method and Description
Object	clone()
CoherentSet	getCoherentSet() Return CoherentSet attribute of this Sample, if it exists.
T	getData() Gets the data associated with this Sample.
KeyHash	getKey() Gets the key of this Sample.
ChangeKind	getKind() Get the ChangeKind of this Sample.
Object	getProperty(String key)
long	getSequenceNumber() Gets the sequence number of this Sample.
long	getSourceTimeStamp() Gets the sourceTimestamp associated with this Sample.
long	getTimestamp() Gets the timestamp associated with this Sample.
Guid	getWriterGuid() Gets the Guid of the writer that wrote this Sample originally.
boolean	isDisposed() Gets the value of disposeFlag of StatusInfo parameter.
boolean	isUnregistered() Gets the value of unregisterFlag of StatusInfo parameter.
void	setCoherentSet(CoherentSet cs) Sets a CoherentSet attribute for this Sample.
void	setProperty(String key, Object value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Sample

public Sample(long seqNum)

This constructor is used to create a Sample, that has no content. It is used to pass only inline QoS parameters to remote reader. For example, indicating an end of coherent set.

Parameters:

seqNum - Sequence number

Sample

public Sample(Guid writerGuid,
              Marshaller<T> m,
              long seqNum,
              long timestamp,
              ChangeKind kind,
              T obj)

This constructor is used when adding Sample to UDDSWriterCache.

Parameters:

writerGuid - Guid of the writer

m - Marshaller used

seqNum - Sequence number

timestamp - Timestamp of this sample

kind - ChangeKind

obj - Object of type T

Sample

public Sample(Guid writerGuid,
              Marshaller<T> m,
              long seqNum,
              long timestamp,
              long sourceTimestamp,
              Data data)

This constructor is used when adding Sample to UDDSReaderCache.

Parameters:

writerGuid - Guid of the writer

m - Marshaller used

seqNum - Sequence number

timestamp - Timestamp of sample

sourceTimestamp - source timestamp of sample

data - Data, whose payload is decoded into Object of type T

Method Detail

getData

public T getData()

Gets the data associated with this Sample.

Returns:

data

getTimestamp

public long getTimestamp()

Gets the timestamp associated with this Sample. Time stamp can be either local timestamp, or remote writers timestamp, based on DESTINATION_ORDER QoS policy.

Returns:

timestamp in milliseconds.

getSourceTimeStamp

public long getSourceTimeStamp()

Gets the sourceTimestamp associated with this Sample. Returns the timestamp set by remote writer. If remote writer did not provide timestamp, it has been set to reception time.

Returns:

source timestamp in milliseconds

isDisposed

public boolean isDisposed()

Gets the value of disposeFlag of StatusInfo parameter. StatusInfo parameter is part of Data submessage.

Returns:

true, if disposeFlag is set

See Also:

StatusInfo

isUnregistered

public boolean isUnregistered()

Gets the value of unregisterFlag of StatusInfo parameter. StatusInfo parameter is part of Data submessage.

Returns:

true, if unregisterFlag is set

See Also:

StatusInfo

getWriterGuid

public Guid getWriterGuid()

Gets the Guid of the writer that wrote this Sample originally.

Returns:

Guid of the writer

getSequenceNumber

public long getSequenceNumber()

Gets the sequence number of this Sample.

Returns:

sequence number

getKey

public KeyHash getKey()

Gets the key of this Sample. Key of the Sample is used to distinguish between instances, when transmitting Samples over the wire.

Returns:

Key, or null if this Sample does not have a key.

getKind

public ChangeKind getKind()

Get the ChangeKind of this Sample.

Returns:

ChangeKind May be null, if this Sample does not represent a change to an instance.

getCoherentSet

public CoherentSet getCoherentSet()

Return CoherentSet attribute of this Sample, if it exists.

Returns:

CoherentSet, or null if one has not been set

setCoherentSet

public void setCoherentSet(CoherentSet cs)

Sets a CoherentSet attribute for this Sample.

Parameters:

cs - CoherentSet to set

toString

public String toString()

Overrides:

toString in class Object

getProperty

public Object getProperty(String key)

setProperty

public void setProperty(String key,
                        Object value)

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException