Class EntityID

java.lang.Object
edu.nps.moves.dis7.EntityID
All Implemented Interfaces:
java.io.Serializable

public class EntityID
extends java.lang.Object
implements java.io.Serializable
more laconically named EntityIdentifier IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
See Also:
Serialized Form
  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected short applicationID
    application number ID
    protected short entityID
    Entity number ID
    protected short siteID
    Site ID
  • Constructor Summary

    Constructors 
    Constructor Description
    EntityID()
    Constructor
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    boolean equalsImpl​(java.lang.Object obj)
    Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
    short getApplicationID()
    Getter for applicationID
    short getEntityID()
    Getter for entityID
    int getMarshalledSize()
    Returns the size of this serialized object in bytes
    short getSiteID()
    Getter for siteID
    void marshal​(java.io.DataOutputStream dos)
    Serializes an object to a DataOutputStream.
    void marshal​(java.nio.ByteBuffer buff)
    Packs an object into the ByteBuffer.
    EntityID setApplicationID​(short pApplicationID)
    Setter for applicationID
    EntityID setEntityID​(short pEntityID)
    Setter for entityID
    EntityID setSiteID​(short pSiteID)
    Setter for siteID
    java.lang.String toString()  
    int unmarshal​(java.io.DataInputStream dis)
    Unserializes an object from a DataInputStream.
    int unmarshal​(java.nio.ByteBuffer buff)
    Unpacks a Pdu from the underlying data.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • siteID

      protected short siteID
      Site ID
    • applicationID

      protected short applicationID
      application number ID
    • entityID

      protected short entityID
      Entity number ID
  • Constructor Details

    • EntityID

      public EntityID()
      Constructor
  • Method Details

    • getMarshalledSize

      public int getMarshalledSize()
      Returns the size of this serialized object in bytes
    • setSiteID

      public EntityID setSiteID​(short pSiteID)
      Setter for siteID
    • getSiteID

      public short getSiteID()
      Getter for siteID
    • setApplicationID

      public EntityID setApplicationID​(short pApplicationID)
      Setter for applicationID
    • getApplicationID

      public short getApplicationID()
      Getter for applicationID
    • setEntityID

      public EntityID setEntityID​(short pEntityID)
      Setter for entityID
    • getEntityID

      public short getEntityID()
      Getter for entityID
    • marshal

      public void marshal​(java.io.DataOutputStream dos) throws java.lang.Exception
      Serializes an object to a DataOutputStream.
      Parameters:
      dos - the OutputStream
      Throws:
      java.lang.Exception - if something goes wrong
      See Also:
      DataOutputStream
    • unmarshal

      public int unmarshal​(java.io.DataInputStream dis) throws java.lang.Exception
      Unserializes an object from a DataInputStream.
      Parameters:
      dis - the InputStream
      Returns:
      unmarshalled size
      Throws:
      java.lang.Exception - if something goes wrong
      See Also:
      DataInputStream
    • marshal

      public void marshal​(java.nio.ByteBuffer buff) throws java.lang.Exception
      Packs an object into the ByteBuffer.
      Parameters:
      buff - The ByteBuffer at the position to begin writing
      Throws:
      java.nio.BufferOverflowException - if buff is too small
      java.nio.ReadOnlyBufferException - if buff is read only
      java.lang.Exception - ByteBuffer-generated exception
      See Also:
      ByteBuffer
    • unmarshal

      public int unmarshal​(java.nio.ByteBuffer buff) throws java.lang.Exception
      Unpacks a Pdu from the underlying data.
      Parameters:
      buff - The ByteBuffer at the position to begin reading
      Returns:
      marshalled size
      Throws:
      java.nio.BufferUnderflowException - if buff is too small
      java.lang.Exception - ByteBuffer-generated exception
      See Also:
      ByteBuffer
    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object
    • equalsImpl

      public boolean equalsImpl​(java.lang.Object obj)
      Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
      Parameters:
      obj - the object to compare to
      Returns:
      true if the objects are equal, false otherwise.
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object