net.sf.jrtps.message.parameter

Class Parameter

java.lang.Object

net.sf.jrtps.message.parameter.Parameter

Direct Known Subclasses:

BaseTypeName, BuiltinTopicKey, CoherentSet, ContentFilterInfo, ContentFilterProperty, DefaultUnicastIPAddress, DefaultUnicastPort, DeprecatedParameter, DirectedWrite, EndpointSet, EntityName, EquivalentTypeName, ExpectsInlineQos, GroupEntityId, GroupGuid, IdentityToken, KeyHash, LocatorParameter, MetatrafficMulticastIPAddress, MetatrafficMulticastPort, MetatrafficUnicastIPAddress, MetatrafficUnicastPort, MulticastIPAddress, OriginalWriterInfo, Pad, ParticipantEntityId, ParticipantGuid, ParticipantLeaseDuration, ParticipantManualLivelinessCount, PermissionsToken, PropertyList, ProtocolVersion, QosDataRepresentation, QosDeadline, QosDestinationOrder, QosDurability, QosDurabilityService, QosGroupData, QosHistory, QosLatencyBudget, QosLifespan, QosLiveliness, QosOwnership, QosOwnershipStrength, QosPartition, QosPresentation, QosReliability, QosResourceLimits, QosTimeBasedFilter, QosTopicData, QosTransportPriority, QosTypeConsistencyEnforcement, QosUserData, Sentinel, StatusInfo, TopicName, TypeMaxSizeSerialized, TypeName, TypeObject, UnknownParameter, VendorId, VendorSpecificParameter, X509Cert

public abstract class Parameter
extends Object

Parameter is used to encapsulate data for builtin entities. see 9.6.2.2.2 ParameterID values

Author:

mcr70

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Parameter(ParameterId id) Constructs Parameter with null bytes.
protected	Parameter(ParameterId id, byte[] bytes) Constructs Parameter with given bytes.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Parameter value
ParameterId	getParameterId() Get the parameterId of this parameter. see 9.6.2.2.2 ParameterID values
abstract void	read(RTPSByteBuffer bb, int length)
protected void	readBytes(RTPSByteBuffer bb, int length) This method can be used by implementing classes to read bytes of this parameter to byte array.
String	toString()
protected void	writeBytes(RTPSByteBuffer bb) This method can be used by implementing classes to write bytes of this parameter to RTPSByteBuffer.
abstract void	writeTo(RTPSByteBuffer bb) Writes this Parameter into given RTPSByteBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

protected Parameter(ParameterId id)

Constructs Parameter with null bytes. Bytes are expected to be read by read(RTPSByteBuffer, int)

Parameters:

id - ParameterId

See Also:

read(RTPSByteBuffer, int)

Parameter

protected Parameter(ParameterId id,
                    byte[] bytes)

Constructs Parameter with given bytes.

Parameters:

id - ParameterId

bytes - byte array of Parameter

Method Detail

getParameterId

public ParameterId getParameterId()

Get the parameterId of this parameter. see 9.6.2.2.2 ParameterID values

Returns:

ParameterEnum

getBytes

public byte[] getBytes()

Parameter value

Returns:

bytes

read

public abstract void read(RTPSByteBuffer bb,
                          int length)

readBytes

protected final void readBytes(RTPSByteBuffer bb,
                               int length)

This method can be used by implementing classes to read bytes of this parameter to byte array.

Parameters:

bb - RTPSByteBuffer, that is used

length - number of bytes

writeBytes

protected final void writeBytes(RTPSByteBuffer bb)

This method can be used by implementing classes to write bytes of this parameter to RTPSByteBuffer. This method must be paired with readBytes(RTPSByteBuffer, int).

Parameters:

bb - Writes bytes into this RTPSByteBuffer

writeTo

public abstract void writeTo(RTPSByteBuffer bb)

Writes this Parameter into given RTPSByteBuffer

Parameters:

bb - RTPSByteBuffer

toString

public String toString()

Overrides:

toString in class Object