edu.nps.moves.dis.LinearObjectStatePdu Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-dis Show documentation
Show all versions of open-dis Show documentation
An open source implementation of the Distributed Interactive Simulation (DIS) IEEE-1278 protocol
package edu.nps.moves.dis;
import java.util.*;
import java.io.*;
import edu.nps.moves.disenum.*;
import edu.nps.moves.disutil.*;
// Jaxb and Hibernate annotations generally won't work on mobile devices. XML serialization uses jaxb, and
// javax.persistence uses the JPA JSR, aka hibernate. See the Hibernate site for details.
// To generate Java code without these, and without the annotations scattered through the
// see the XMLPG java code generator, and set the boolean useHibernateAnnotations and useJaxbAnnotions
// to false, and then regenerate the code
import javax.xml.bind.*; // Used for JAXB XML serialization
import javax.xml.bind.annotation.*; // Used for XML serialization annotations (the @ stuff)
import javax.persistence.*; // Used for JPA/Hibernate SQL persistence
/**
* Section 5.3.11.4: Information abut the addition or modification of a synthecic enviroment object that is anchored to the terrain with a single point and has size or orientation. COMPLETE
*
* Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved.
* This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html
*
* @author DMcG
*/
@Entity // Hibernate
@Inheritance(strategy=InheritanceType.JOINED) // Hibernate
public class LinearObjectStatePdu extends SyntheticEnvironmentFamilyPdu implements Serializable
{
/** Object in synthetic environment */
protected EntityID objectID = new EntityID();
/** Object with which this point object is associated */
protected EntityID referencedObjectID = new EntityID();
/** unique update number of each state transition of an object */
protected int updateNumber;
/** force ID */
protected short forceID;
/** number of linear segment parameters */
protected short numberOfSegments;
/** requesterID */
protected SimulationAddress requesterID = new SimulationAddress();
/** receiver ID */
protected SimulationAddress receivingID = new SimulationAddress();
/** Object type */
protected ObjectType objectType = new ObjectType();
/** Linear segment parameters */
protected List< LinearSegmentParameter> linearSegmentParameters = new ArrayList();
/** Constructor */
public LinearObjectStatePdu()
{
setPduType( (short)44 );
}
@Transient // Marked as transient to prevent hibernate from thinking this is a persistent property
public int getMarshalledSize()
{
int marshalSize = 0;
marshalSize = super.getMarshalledSize();
marshalSize = marshalSize + objectID.getMarshalledSize(); // objectID
marshalSize = marshalSize + referencedObjectID.getMarshalledSize(); // referencedObjectID
marshalSize = marshalSize + 2; // updateNumber
marshalSize = marshalSize + 1; // forceID
marshalSize = marshalSize + 1; // numberOfSegments
marshalSize = marshalSize + requesterID.getMarshalledSize(); // requesterID
marshalSize = marshalSize + receivingID.getMarshalledSize(); // receivingID
marshalSize = marshalSize + objectType.getMarshalledSize(); // objectType
for(int idx=0; idx < linearSegmentParameters.size(); idx++)
{
LinearSegmentParameter listElement = linearSegmentParameters.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
public void setObjectID(EntityID pObjectID)
{ objectID = pObjectID;
}
// HIBERNATE: this ivar is a foreign key, linked to the below class table.
// It is not a DIS-standard variable and is not marshalled to IEEE-1278.1
public long fk_objectID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_objectID")
public EntityID getObjectID()
{ return objectID;
}
public void setReferencedObjectID(EntityID pReferencedObjectID)
{ referencedObjectID = pReferencedObjectID;
}
// HIBERNATE: this ivar is a foreign key, linked to the below class table.
// It is not a DIS-standard variable and is not marshalled to IEEE-1278.1
public long fk_referencedObjectID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_referencedObjectID")
public EntityID getReferencedObjectID()
{ return referencedObjectID;
}
public void setUpdateNumber(int pUpdateNumber)
{ updateNumber = pUpdateNumber;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public int getUpdateNumber()
{ return updateNumber;
}
public void setForceID(short pForceID)
{ forceID = pForceID;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public short getForceID()
{ return forceID;
}
@XmlAttribute
@Basic
public short getNumberOfSegments()
{ return (short)linearSegmentParameters.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfSegments method will also be based on the actual list length rather than this value.
* The method is simply here for java bean completeness.
*/
public void setNumberOfSegments(short pNumberOfSegments)
{ numberOfSegments = pNumberOfSegments;
}
public void setRequesterID(SimulationAddress pRequesterID)
{ requesterID = pRequesterID;
}
// HIBERNATE: this ivar is a foreign key, linked to the below class table.
// It is not a DIS-standard variable and is not marshalled to IEEE-1278.1
public long fk_requesterID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_requesterID")
public SimulationAddress getRequesterID()
{ return requesterID;
}
public void setReceivingID(SimulationAddress pReceivingID)
{ receivingID = pReceivingID;
}
// HIBERNATE: this ivar is a foreign key, linked to the below class table.
// It is not a DIS-standard variable and is not marshalled to IEEE-1278.1
public long fk_receivingID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_receivingID")
public SimulationAddress getReceivingID()
{ return receivingID;
}
public void setObjectType(ObjectType pObjectType)
{ objectType = pObjectType;
}
// HIBERNATE: this ivar is a foreign key, linked to the below class table.
// It is not a DIS-standard variable and is not marshalled to IEEE-1278.1
public long fk_objectType;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_objectType")
public ObjectType getObjectType()
{ return objectType;
}
public void setLinearSegmentParameters(List pLinearSegmentParameters)
{ linearSegmentParameters = pLinearSegmentParameters;
}
@XmlElementWrapper(name="linearSegmentParametersList" ) // Jaxb
@OneToMany // Hibernate
public List getLinearSegmentParameters()
{ return linearSegmentParameters; }
public void marshal(DataOutputStream dos)
{
super.marshal(dos);
try
{
objectID.marshal(dos);
referencedObjectID.marshal(dos);
dos.writeShort( (short)updateNumber);
dos.writeByte( (byte)forceID);
dos.writeByte( (byte)linearSegmentParameters.size());
requesterID.marshal(dos);
receivingID.marshal(dos);
objectType.marshal(dos);
for(int idx = 0; idx < linearSegmentParameters.size(); idx++)
{
LinearSegmentParameter aLinearSegmentParameter = linearSegmentParameters.get(idx);
aLinearSegmentParameter.marshal(dos);
} // end of list marshalling
} // end try
catch(Exception e)
{
System.out.println(e);}
} // end of marshal method
public void unmarshal(DataInputStream dis)
{
super.unmarshal(dis);
try
{
objectID.unmarshal(dis);
referencedObjectID.unmarshal(dis);
updateNumber = (int)dis.readUnsignedShort();
forceID = (short)dis.readUnsignedByte();
numberOfSegments = (short)dis.readUnsignedByte();
requesterID.unmarshal(dis);
receivingID.unmarshal(dis);
objectType.unmarshal(dis);
for(int idx = 0; idx < numberOfSegments; idx++)
{
LinearSegmentParameter anX = new LinearSegmentParameter();
anX.unmarshal(dis);
linearSegmentParameters.add(anX);
}
} // end try
catch(Exception e)
{
System.out.println(e);
}
} // end of unmarshal method
/**
* Packs a Pdu into the ByteBuffer.
* @throws java.nio.BufferOverflowException if buff is too small
* @throws java.nio.ReadOnlyBufferException if buff is read only
* @see java.nio.ByteBuffer
* @param buff The ByteBuffer at the position to begin writing
* @since ??
*/
public void marshal(java.nio.ByteBuffer buff)
{
super.marshal(buff);
objectID.marshal(buff);
referencedObjectID.marshal(buff);
buff.putShort( (short)updateNumber);
buff.put( (byte)forceID);
buff.put( (byte)linearSegmentParameters.size());
requesterID.marshal(buff);
receivingID.marshal(buff);
objectType.marshal(buff);
for(int idx = 0; idx < linearSegmentParameters.size(); idx++)
{
LinearSegmentParameter aLinearSegmentParameter = (LinearSegmentParameter)linearSegmentParameters.get(idx);
aLinearSegmentParameter.marshal(buff);
} // end of list marshalling
} // end of marshal method
/**
* Unpacks a Pdu from the underlying data.
* @throws java.nio.BufferUnderflowException if buff is too small
* @see java.nio.ByteBuffer
* @param buff The ByteBuffer at the position to begin reading
* @since ??
*/
public void unmarshal(java.nio.ByteBuffer buff)
{
super.unmarshal(buff);
objectID.unmarshal(buff);
referencedObjectID.unmarshal(buff);
updateNumber = (int)(buff.getShort() & 0xFFFF);
forceID = (short)(buff.get() & 0xFF);
numberOfSegments = (short)(buff.get() & 0xFF);
requesterID.unmarshal(buff);
receivingID.unmarshal(buff);
objectType.unmarshal(buff);
for(int idx = 0; idx < numberOfSegments; idx++)
{
LinearSegmentParameter anX = new LinearSegmentParameter();
anX.unmarshal(buff);
linearSegmentParameters.add(anX);
}
} // end of unmarshal method
/*
* The equals method doesn't always work--mostly it works only on classes that consist only of primitives. Be careful.
*/
@Override
public boolean equals(Object obj)
{
if(this == obj){
return true;
}
if(obj == null){
return false;
}
if(getClass() != obj.getClass())
return false;
return equalsImpl(obj);
}
@Override
public boolean equalsImpl(Object obj)
{
boolean ivarsEqual = true;
if(!(obj instanceof LinearObjectStatePdu))
return false;
final LinearObjectStatePdu rhs = (LinearObjectStatePdu)obj;
if( ! (objectID.equals( rhs.objectID) )) ivarsEqual = false;
if( ! (referencedObjectID.equals( rhs.referencedObjectID) )) ivarsEqual = false;
if( ! (updateNumber == rhs.updateNumber)) ivarsEqual = false;
if( ! (forceID == rhs.forceID)) ivarsEqual = false;
if( ! (numberOfSegments == rhs.numberOfSegments)) ivarsEqual = false;
if( ! (requesterID.equals( rhs.requesterID) )) ivarsEqual = false;
if( ! (receivingID.equals( rhs.receivingID) )) ivarsEqual = false;
if( ! (objectType.equals( rhs.objectType) )) ivarsEqual = false;
for(int idx = 0; idx < linearSegmentParameters.size(); idx++)
{
if( ! ( linearSegmentParameters.get(idx).equals(rhs.linearSegmentParameters.get(idx)))) ivarsEqual = false;
}
return ivarsEqual && super.equalsImpl(rhs);
}
} // end of class