edu.nps.moves.dis.MinefieldQueryPdu 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.10.2 Query a minefield for information about individual mines. Requires manual clean up to get the padding right. UNFINISHED
*
* 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 MinefieldQueryPdu extends MinefieldFamilyPdu implements Serializable
{
/** Minefield ID */
protected EntityID minefieldID = new EntityID();
/** EID of entity making the request */
protected EntityID requestingEntityID = new EntityID();
/** request ID */
protected short requestID;
/** Number of perimeter points for the minefield */
protected short numberOfPerimeterPoints;
/** Padding */
protected short pad2;
/** Number of sensor types */
protected short numberOfSensorTypes;
/** data filter, 32 boolean fields */
protected long dataFilter;
/** Entity type of mine being requested */
protected EntityType requestedMineType = new EntityType();
/** perimeter points of request */
protected List< Point> requestedPerimeterPoints = new ArrayList();
/** Sensor types, each 16 bits long */
protected List< TwoByteChunk> sensorTypes = new ArrayList();
/** Constructor */
public MinefieldQueryPdu()
{
setPduType( (short)38 );
}
@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 + minefieldID.getMarshalledSize(); // minefieldID
marshalSize = marshalSize + requestingEntityID.getMarshalledSize(); // requestingEntityID
marshalSize = marshalSize + 1; // requestID
marshalSize = marshalSize + 1; // numberOfPerimeterPoints
marshalSize = marshalSize + 1; // pad2
marshalSize = marshalSize + 1; // numberOfSensorTypes
marshalSize = marshalSize + 4; // dataFilter
marshalSize = marshalSize + requestedMineType.getMarshalledSize(); // requestedMineType
for(int idx=0; idx < requestedPerimeterPoints.size(); idx++)
{
Point listElement = requestedPerimeterPoints.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
for(int idx=0; idx < sensorTypes.size(); idx++)
{
TwoByteChunk listElement = sensorTypes.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
public void setMinefieldID(EntityID pMinefieldID)
{ minefieldID = pMinefieldID;
}
// 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_minefieldID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_minefieldID")
public EntityID getMinefieldID()
{ return minefieldID;
}
public void setRequestingEntityID(EntityID pRequestingEntityID)
{ requestingEntityID = pRequestingEntityID;
}
// 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_requestingEntityID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_requestingEntityID")
public EntityID getRequestingEntityID()
{ return requestingEntityID;
}
public void setRequestID(short pRequestID)
{ requestID = pRequestID;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public short getRequestID()
{ return requestID;
}
@XmlAttribute
@Basic
public short getNumberOfPerimeterPoints()
{ return (short)requestedPerimeterPoints.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfPerimeterPoints 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 setNumberOfPerimeterPoints(short pNumberOfPerimeterPoints)
{ numberOfPerimeterPoints = pNumberOfPerimeterPoints;
}
public void setPad2(short pPad2)
{ pad2 = pPad2;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public short getPad2()
{ return pad2;
}
@XmlAttribute
@Basic
public short getNumberOfSensorTypes()
{ return (short)sensorTypes.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfSensorTypes 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 setNumberOfSensorTypes(short pNumberOfSensorTypes)
{ numberOfSensorTypes = pNumberOfSensorTypes;
}
public void setDataFilter(long pDataFilter)
{ dataFilter = pDataFilter;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public long getDataFilter()
{ return dataFilter;
}
public void setRequestedMineType(EntityType pRequestedMineType)
{ requestedMineType = pRequestedMineType;
}
// 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_requestedMineType;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_requestedMineType")
public EntityType getRequestedMineType()
{ return requestedMineType;
}
public void setRequestedPerimeterPoints(List pRequestedPerimeterPoints)
{ requestedPerimeterPoints = pRequestedPerimeterPoints;
}
@XmlElementWrapper(name="requestedPerimeterPointsList" ) // Jaxb
@OneToMany // Hibernate
public List getRequestedPerimeterPoints()
{ return requestedPerimeterPoints; }
public void setSensorTypes(List pSensorTypes)
{ sensorTypes = pSensorTypes;
}
@XmlElementWrapper(name="sensorTypesList" ) // Jaxb
@OneToMany // Hibernate
public List getSensorTypes()
{ return sensorTypes; }
public void marshal(DataOutputStream dos)
{
super.marshal(dos);
try
{
minefieldID.marshal(dos);
requestingEntityID.marshal(dos);
dos.writeByte( (byte)requestID);
dos.writeByte( (byte)requestedPerimeterPoints.size());
dos.writeByte( (byte)pad2);
dos.writeByte( (byte)sensorTypes.size());
dos.writeInt( (int)dataFilter);
requestedMineType.marshal(dos);
for(int idx = 0; idx < requestedPerimeterPoints.size(); idx++)
{
Point aPoint = requestedPerimeterPoints.get(idx);
aPoint.marshal(dos);
} // end of list marshalling
for(int idx = 0; idx < sensorTypes.size(); idx++)
{
TwoByteChunk aTwoByteChunk = sensorTypes.get(idx);
aTwoByteChunk.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
{
minefieldID.unmarshal(dis);
requestingEntityID.unmarshal(dis);
requestID = (short)dis.readUnsignedByte();
numberOfPerimeterPoints = (short)dis.readUnsignedByte();
pad2 = (short)dis.readUnsignedByte();
numberOfSensorTypes = (short)dis.readUnsignedByte();
dataFilter = dis.readInt();
requestedMineType.unmarshal(dis);
for(int idx = 0; idx < numberOfPerimeterPoints; idx++)
{
Point anX = new Point();
anX.unmarshal(dis);
requestedPerimeterPoints.add(anX);
}
for(int idx = 0; idx < numberOfSensorTypes; idx++)
{
TwoByteChunk anX = new TwoByteChunk();
anX.unmarshal(dis);
sensorTypes.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);
minefieldID.marshal(buff);
requestingEntityID.marshal(buff);
buff.put( (byte)requestID);
buff.put( (byte)requestedPerimeterPoints.size());
buff.put( (byte)pad2);
buff.put( (byte)sensorTypes.size());
buff.putInt( (int)dataFilter);
requestedMineType.marshal(buff);
for(int idx = 0; idx < requestedPerimeterPoints.size(); idx++)
{
Point aPoint = (Point)requestedPerimeterPoints.get(idx);
aPoint.marshal(buff);
} // end of list marshalling
for(int idx = 0; idx < sensorTypes.size(); idx++)
{
TwoByteChunk aTwoByteChunk = (TwoByteChunk)sensorTypes.get(idx);
aTwoByteChunk.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);
minefieldID.unmarshal(buff);
requestingEntityID.unmarshal(buff);
requestID = (short)(buff.get() & 0xFF);
numberOfPerimeterPoints = (short)(buff.get() & 0xFF);
pad2 = (short)(buff.get() & 0xFF);
numberOfSensorTypes = (short)(buff.get() & 0xFF);
dataFilter = buff.getInt();
requestedMineType.unmarshal(buff);
for(int idx = 0; idx < numberOfPerimeterPoints; idx++)
{
Point anX = new Point();
anX.unmarshal(buff);
requestedPerimeterPoints.add(anX);
}
for(int idx = 0; idx < numberOfSensorTypes; idx++)
{
TwoByteChunk anX = new TwoByteChunk();
anX.unmarshal(buff);
sensorTypes.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 MinefieldQueryPdu))
return false;
final MinefieldQueryPdu rhs = (MinefieldQueryPdu)obj;
if( ! (minefieldID.equals( rhs.minefieldID) )) ivarsEqual = false;
if( ! (requestingEntityID.equals( rhs.requestingEntityID) )) ivarsEqual = false;
if( ! (requestID == rhs.requestID)) ivarsEqual = false;
if( ! (numberOfPerimeterPoints == rhs.numberOfPerimeterPoints)) ivarsEqual = false;
if( ! (pad2 == rhs.pad2)) ivarsEqual = false;
if( ! (numberOfSensorTypes == rhs.numberOfSensorTypes)) ivarsEqual = false;
if( ! (dataFilter == rhs.dataFilter)) ivarsEqual = false;
if( ! (requestedMineType.equals( rhs.requestedMineType) )) ivarsEqual = false;
for(int idx = 0; idx < requestedPerimeterPoints.size(); idx++)
{
if( ! ( requestedPerimeterPoints.get(idx).equals(rhs.requestedPerimeterPoints.get(idx)))) ivarsEqual = false;
}
for(int idx = 0; idx < sensorTypes.size(); idx++)
{
if( ! ( sensorTypes.get(idx).equals(rhs.sensorTypes.get(idx)))) ivarsEqual = false;
}
return ivarsEqual && super.equalsImpl(rhs);
}
} // end of class