net.sf.jrtps.builtin

Class DiscoveredData

java.lang.Object

net.sf.jrtps.builtin.DiscoveredData

Direct Known Subclasses:

ParticipantData, PublicationData, SubscriptionData, TopicData

public class DiscoveredData
extends Object

Base class for data, that is received during discovery.

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
protected Guid	key
protected QualityOfService	qos
protected String	topicName
protected String	typeName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiscoveredData() This constructor is used when DiscoveredData is being created from RTPSByteBuffer
protected	DiscoveredData(String typeName, String topicName, Guid key, QualityOfService qos) This constructor is used when DiscoveredData is being created from scratch

Method Summary

Modifier and Type	Method and Description
protected void	addParameter(Parameter param) Adds a Parameter that was not handled by subclass.
protected void	addQosPolicy(QosPolicy<?> policy) Adds a QosPolicy.
Guid	getBuiltinTopicKey() Gets the Guid of the entity represented by this DiscoveredData.
Set<QosPolicy<?>>	getInlineableQosPolicies() Get inlineable Qos policies.
Parameter	getParameter(ParameterId id) Gets the Parameter with given ParameterEnum
List<Parameter>	getParameters() Gets all the parameters that were received during discovery.
QualityOfService	getQualityOfService() Gets the QualityOfService of this DiscoveredData.
String	getTopicName() Get the topic name that is associated with this DiscoveredData.
String	getTypeName() Get the type name that is associated with this DiscoveresData.
protected void	resolveInconsistencies() This method must be called after all the Parameters have been read from the stream to resolve possible inconsistent policies.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

qos

protected QualityOfService qos

typeName

protected String typeName

topicName

protected String topicName

key

protected Guid key

Constructor Detail

DiscoveredData

protected DiscoveredData()

This constructor is used when DiscoveredData is being created from RTPSByteBuffer

DiscoveredData

protected DiscoveredData(String typeName,
                         String topicName,
                         Guid key,
                         QualityOfService qos)

This constructor is used when DiscoveredData is being created from scratch

Parameters:

typeName - Type name of the data

topicName - name of the topic

key - guid of the remote entity, which acts as a key for topic

qos - QualityOfService of discovered entity

Method Detail

resolveInconsistencies

protected void resolveInconsistencies()
                               throws InconsistentPolicy

This method must be called after all the Parameters have been read from the stream to resolve possible inconsistent policies.

Throws:

InconsistentPolicy - if discovered data would contain inconsistent policies.

addParameter

protected void addParameter(Parameter param)

Adds a Parameter that was not handled by subclass.

Parameters:

param - Parameter

getParameters

public List<Parameter> getParameters()

Gets all the parameters that were received during discovery.

Returns:

parameters

getTypeName

public String getTypeName()

Get the type name that is associated with this DiscoveresData. Type name is formed from the PID_TYPE_NAME parameter

Returns:

typeName

getTopicName

public String getTopicName()

Get the topic name that is associated with this DiscoveredData. Topic name is formed from the PID_TOPIC_NAME parameter

Returns:

topicName

getBuiltinTopicKey

public Guid getBuiltinTopicKey()

Gets the Guid of the entity represented by this DiscoveredData.

Returns:

key as Guid

getQualityOfService

public QualityOfService getQualityOfService()

Gets the QualityOfService of this DiscoveredData.

Returns:

QualityOfService

getParameter

public Parameter getParameter(ParameterId id)

Gets the Parameter with given ParameterEnum

Parameters:

id - Id of the Parameter

Returns:

Parameter, or null if not found

addQosPolicy

protected void addQosPolicy(QosPolicy<?> policy)

Adds a QosPolicy.

Parameters:

policy - QosPolicy to add

getInlineableQosPolicies

public Set<QosPolicy<?>> getInlineableQosPolicies()

Get inlineable Qos policies. Such policies implement InlineParameter.

Returns:

QosPolicies that can be inlined to Data

See Also:

Data.getInlineQos(), InlineQoS

toString

public String toString()

Overrides:

toString in class Object