EntityId (jRTPS 1.4.0 API)

java.lang.Object
- net.sf.jrtps.types.EntityId

Direct Known Subclasses:

EntityId.BuiltinParticipantMessageReader, EntityId.BuiltinParticipantMessageSecureReader, EntityId.BuiltinParticipantMessageSecureWriter, EntityId.BuiltinParticipantMessageWriter, EntityId.BuiltinParticipantStatelessReader, EntityId.BuiltinParticipantStatelessWriter, EntityId.BuiltinParticipantVolatileMessageSecureReader, EntityId.BuiltinParticipantVolatileMessageSecureWriter, EntityId.Participant, EntityId.SEDPbuiltinPublicationsReader, EntityId.SEDPbuiltinPublicationsSecureReader, EntityId.SEDPbuiltinPublicationsSecureWriter, EntityId.SEDPbuiltinPublicationsWriter, EntityId.SEDPbuiltinSubscriptionsReader, EntityId.SEDPbuiltinSubscriptionsSecureReader, EntityId.SEDPbuiltinSubscriptionsSecureWriter, EntityId.SEDPbuiltinSubscriptionsWriter, EntityId.SEDPbuiltinTopicReader, EntityId.SEDPbuiltinTopicWriter, EntityId.SPDPbuiltinParticipantReader, EntityId.SPDPbuiltinParticipantWriter, EntityId.UnknownEntity, EntityId.UserDefinedEntityId, EntityId.VendorSpecificEntityId
```
public abstract class EntityId
extends Object
```
see 9.3.1.2 Mapping of the EntityId_t NOTE: this implementation ignores Deprecated EntityIds in version 2.1 of the Protocol as specified in 9.3.1.4

Author:

mcr70

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityId.BuiltinParticipantMessageReader` EntityId representing builtin ParticipantMessage reader.
`static class`	`EntityId.BuiltinParticipantMessageSecureReader` EntityId representing builtin secure ParticipantMessage reader.
`static class`	`EntityId.BuiltinParticipantMessageSecureWriter` EntityId representing builtin ParticipantMessage secure writer.
`static class`	`EntityId.BuiltinParticipantMessageWriter` EntityId representing builtin ParticipantMessage writer.
`static class`	`EntityId.BuiltinParticipantStatelessReader` Used with DDS security.
`static class`	`EntityId.BuiltinParticipantStatelessWriter` Used with DDS security.
`static class`	`EntityId.BuiltinParticipantVolatileMessageSecureReader` Used with DDS security.
`static class`	`EntityId.BuiltinParticipantVolatileMessageSecureWriter` Used with DDS security.
`static class`	`EntityId.Participant` EntityId representing RTPS Participant.
`static class`	`EntityId.SEDPbuiltinPublicationsReader` EntityId representing SEDP builtin publications reader.
`static class`	`EntityId.SEDPbuiltinPublicationsSecureReader` EntityId representing SEDP builtin publications secure reader.
`static class`	`EntityId.SEDPbuiltinPublicationsSecureWriter` EntityId representing SEDP builtin publications secure writer.
`static class`	`EntityId.SEDPbuiltinPublicationsWriter` EntityId representing SEDP builtin publications writer.
`static class`	`EntityId.SEDPbuiltinSubscriptionsReader` EntityId representing SEDP builtin subscriptions reader.
`static class`	`EntityId.SEDPbuiltinSubscriptionsSecureReader` EntityId representing SEDP builtin subscriptions secure reader.
`static class`	`EntityId.SEDPbuiltinSubscriptionsSecureWriter` EntityId representing SEDP builtin subscriptions secure writer.
`static class`	`EntityId.SEDPbuiltinSubscriptionsWriter` EntityId representing SEDP builtin subscriptions writer.
`static class`	`EntityId.SEDPbuiltinTopicReader` EntityId representing SEDP builtin topic reader.
`static class`	`EntityId.SEDPbuiltinTopicWriter` EntityId representing SEDP builtin topic writer.
`static class`	`EntityId.SPDPbuiltinParticipantReader` EntityId representing SPDP builtin participant reader.
`static class`	`EntityId.SPDPbuiltinParticipantWriter` EntityId representing SPDP builtin participant writer.
`static class`	`EntityId.UnknownEntity` EntityId representing an unknown entity.
`static class`	`EntityId.UserDefinedEntityId` EntityId representing an user defined entity.
`static class`	`EntityId.VendorSpecificEntityId` EntityId representing a vendor specific entity.

Field Summary

Fields
Modifier and Type	Field and Description
`static EntityId`	`BUILTIN_PARTICIPANT_MESSAGE_READER` Builtin reader for ParticipantMessage
`static EntityId`	`BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER` Builtin reader for secure ParticipantMessage
`static EntityId`	`BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER` Builtin writer for secure ParticipantMessage
`static EntityId`	`BUILTIN_PARTICIPANT_MESSAGE_WRITER` Builtin writer for ParticipantMessage
`static EntityId`	`BUILTIN_PARTICIPANT_STATELESS_READER`
`static EntityId`	`BUILTIN_PARTICIPANT_STATELESS_WRITER`
`static EntityId`	`BUILTIN_PARTICIPANT_VOLATILE_READER`
`static EntityId`	`BUILTIN_PARTICIPANT_VOLATILE_WRITER`
`static EntityId`	`PARTICIPANT` Entity id representing Participant.
`static EntityId`	`SEDP_BUILTIN_PUBLICATIONS_READER` Builtin reader for publications
`static EntityId`	`SEDP_BUILTIN_PUBLICATIONS_SECURE_READER` Builtin reader for secure publications
`static EntityId`	`SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER` Builtin writer for secure publications
`static EntityId`	`SEDP_BUILTIN_PUBLICATIONS_WRITER` Builtin writer for publications
`static EntityId`	`SEDP_BUILTIN_SUBSCRIPTIONS_READER` Builtin reader for subscriptions
`static EntityId`	`SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER` Builtin reader for secure subscriptions
`static EntityId`	`SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER` Builtin writer for secure subscriptions
`static EntityId`	`SEDP_BUILTIN_SUBSCRIPTIONS_WRITER` Builtin writer for subscriptions
`static EntityId`	`SEDP_BUILTIN_TOPIC_READER` Builtin reader for topic
`static EntityId`	`SEDP_BUILTIN_TOPIC_WRITER` Builtin writer for topic
`static EntityId`	`SPDP_BUILTIN_PARTICIPANT_READER` Builtin reader for SPDP ParticipantData
`static EntityId`	`SPDP_BUILTIN_PARTICIPANT_WRITER` Builtin writer for SPDP ParticipantData
`static EntityId`	`UNKNOWN_ENTITY` Represents an unknown entity

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static EntityId`	`createEntityId(byte[] eKey, int kind)` Reads EntityId from given byte[] and kind.
`boolean`	`equals(EntityId other)`
`byte[]`	`getBytes()` Gets this EntityId as a byte array.
`abstract int`	`getEndpointSetId()` Gets endpoint set id.
`byte[]`	`getEntityKey()` Gets the entityKey of this EntityId
`byte`	`getEntityKind()` Gets the entityKind of this EntityId
`int`	`hashCode()`
`boolean`	`isBuiltinEntity()` Checks whether this entity is a builtin entity or not
`boolean`	`isUserDefinedEntity()` Checks whether this entity is an user defined entity or not
`boolean`	`isVendorSpecifiEntity()` Checks whether this entity is an user defined entity or not
`static EntityId`	`readEntityId(RTPSByteBuffer bb)` Reads an EntityId from RTPSByteBuffer.
`String`	`toString()`
`void`	`writeTo(RTPSByteBuffer bb)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SPDP_BUILTIN_PARTICIPANT_WRITER
```
public static final EntityId SPDP_BUILTIN_PARTICIPANT_WRITER
```
    Builtin writer for SPDP ParticipantData
  - SPDP_BUILTIN_PARTICIPANT_READER
```
public static final EntityId SPDP_BUILTIN_PARTICIPANT_READER
```
    Builtin reader for SPDP ParticipantData
  - SEDP_BUILTIN_SUBSCRIPTIONS_WRITER
```
public static final EntityId SEDP_BUILTIN_SUBSCRIPTIONS_WRITER
```
    Builtin writer for subscriptions
  - SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER
```
public static final EntityId SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER
```
    Builtin writer for secure subscriptions
  - SEDP_BUILTIN_SUBSCRIPTIONS_READER
```
public static final EntityId SEDP_BUILTIN_SUBSCRIPTIONS_READER
```
    Builtin reader for subscriptions
  - SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER
```
public static final EntityId SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER
```
    Builtin reader for secure subscriptions
  - SEDP_BUILTIN_PUBLICATIONS_WRITER
```
public static final EntityId SEDP_BUILTIN_PUBLICATIONS_WRITER
```
    Builtin writer for publications
  - SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER
```
public static final EntityId SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER
```
    Builtin writer for secure publications
  - SEDP_BUILTIN_PUBLICATIONS_READER
```
public static final EntityId SEDP_BUILTIN_PUBLICATIONS_READER
```
    Builtin reader for publications
  - SEDP_BUILTIN_PUBLICATIONS_SECURE_READER
```
public static final EntityId SEDP_BUILTIN_PUBLICATIONS_SECURE_READER
```
    Builtin reader for secure publications
  - SEDP_BUILTIN_TOPIC_WRITER
```
public static final EntityId SEDP_BUILTIN_TOPIC_WRITER
```
    Builtin writer for topic
  - SEDP_BUILTIN_TOPIC_READER
```
public static final EntityId SEDP_BUILTIN_TOPIC_READER
```
    Builtin reader for topic
  - PARTICIPANT
```
public static final EntityId PARTICIPANT
```
    Entity id representing Participant.
    
    See Also:
    
    RTPSParticipant
  - BUILTIN_PARTICIPANT_MESSAGE_WRITER
```
public static final EntityId BUILTIN_PARTICIPANT_MESSAGE_WRITER
```
    Builtin writer for ParticipantMessage
  - BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER
```
public static final EntityId BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER
```
    Builtin writer for secure ParticipantMessage
  - BUILTIN_PARTICIPANT_MESSAGE_READER
```
public static final EntityId BUILTIN_PARTICIPANT_MESSAGE_READER
```
    Builtin reader for ParticipantMessage
  - BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER
```
public static final EntityId BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER
```
    Builtin reader for secure ParticipantMessage
  - BUILTIN_PARTICIPANT_STATELESS_WRITER
```
public static final EntityId BUILTIN_PARTICIPANT_STATELESS_WRITER
```
  - BUILTIN_PARTICIPANT_STATELESS_READER
```
public static final EntityId BUILTIN_PARTICIPANT_STATELESS_READER
```
  - BUILTIN_PARTICIPANT_VOLATILE_WRITER
```
public static final EntityId BUILTIN_PARTICIPANT_VOLATILE_WRITER
```
  - BUILTIN_PARTICIPANT_VOLATILE_READER
```
public static final EntityId BUILTIN_PARTICIPANT_VOLATILE_READER
```
  - UNKNOWN_ENTITY
```
public static final EntityId UNKNOWN_ENTITY
```
    Represents an unknown entity
- Method Detail
  - equals
```
public boolean equals(EntityId other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isBuiltinEntity
```
public boolean isBuiltinEntity()
```
    Checks whether this entity is a builtin entity or not
    
    Returns:
    
    true, if this EntityId_t represents a builtin entity
  - isUserDefinedEntity
```
public boolean isUserDefinedEntity()
```
    Checks whether this entity is an user defined entity or not
    
    Returns:
    
    true, if this EntityId_t represents a user defined entity
  - isVendorSpecifiEntity
```
public boolean isVendorSpecifiEntity()
```
    Checks whether this entity is an user defined entity or not
    
    Returns:
    
    true, if this EntityId_t represents a vendor specific entity
  - writeTo
```
public void writeTo(RTPSByteBuffer bb)
```
  - getBytes
```
public byte[] getBytes()
```
    Gets this EntityId as a byte array. First 3 bytes are key, and last byte is entity kind.
    
    Returns:
    
    a byte array of length 4
  - getEndpointSetId
```
public abstract int getEndpointSetId()
```
    Gets endpoint set id. Endpoint set is used with SPDP ParticipantData to tell remote participant of the builtin endpoints available. Endpoint set id is a bit representing a known entityId
    
    Returns:
    
    endpoint set id.
  - getEntityKey
```
public byte[] getEntityKey()
```
    Gets the entityKey of this EntityId
    
    Returns:
    
    an array of length 3
  - getEntityKind
```
public byte getEntityKind()
```
    Gets the entityKind of this EntityId
    
    Returns:
    
    entityKind
  - createEntityId
```
public static EntityId createEntityId(byte[] eKey,
                                      int kind)
```
    Reads EntityId from given byte[] and kind.
    
    Parameters:
    
    eKey - an array of bytes representing entity key
    
    kind - Kind of entity
    
    Returns:
    
    EntityId
  - readEntityId
```
public static EntityId readEntityId(RTPSByteBuffer bb)
```
    Reads an EntityId from RTPSByteBuffer.
    
    Parameters:
    
    bb - RTPSByteBuffer
    
    Returns:
    
    EntityId
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EntityId

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPDP_BUILTIN_PARTICIPANT_WRITER

SPDP_BUILTIN_PARTICIPANT_READER

SEDP_BUILTIN_SUBSCRIPTIONS_WRITER

SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER

SEDP_BUILTIN_SUBSCRIPTIONS_READER

SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER

SEDP_BUILTIN_PUBLICATIONS_WRITER

SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER

SEDP_BUILTIN_PUBLICATIONS_READER

SEDP_BUILTIN_PUBLICATIONS_SECURE_READER

SEDP_BUILTIN_TOPIC_WRITER

SEDP_BUILTIN_TOPIC_READER

PARTICIPANT

BUILTIN_PARTICIPANT_MESSAGE_WRITER

BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER

BUILTIN_PARTICIPANT_MESSAGE_READER

BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER

BUILTIN_PARTICIPANT_STATELESS_WRITER

BUILTIN_PARTICIPANT_STATELESS_READER

BUILTIN_PARTICIPANT_VOLATILE_WRITER

BUILTIN_PARTICIPANT_VOLATILE_READER

UNKNOWN_ENTITY

Method Detail

equals

hashCode

isBuiltinEntity

isUserDefinedEntity

isVendorSpecifiEntity

writeTo

getBytes

getEndpointSetId

getEntityKey

getEntityKind

createEntityId

readEntityId

toString