edu.nps.moves.dis.ResupplyReceivedPdu 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.5.3. Receipt of supplies is communiated. 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 ResupplyReceivedPdu extends LogisticsFamilyPdu implements Serializable
{
/** Entity that is receiving service */
protected EntityID receivingEntityID = new EntityID();
/** Entity that is supplying */
protected EntityID supplyingEntityID = new EntityID();
/** how many supplies are being offered */
protected short numberOfSupplyTypes;
/** padding */
protected short padding1 = (short)0;
/** padding */
protected byte padding2 = (byte)0;
protected List< SupplyQuantity> supplies = new ArrayList();
/** Constructor */
public ResupplyReceivedPdu()
{
setPduType( (short)7 );
}
@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 + receivingEntityID.getMarshalledSize(); // receivingEntityID
marshalSize = marshalSize + supplyingEntityID.getMarshalledSize(); // supplyingEntityID
marshalSize = marshalSize + 1; // numberOfSupplyTypes
marshalSize = marshalSize + 2; // padding1
marshalSize = marshalSize + 1; // padding2
for(int idx=0; idx < supplies.size(); idx++)
{
SupplyQuantity listElement = supplies.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
public void setReceivingEntityID(EntityID pReceivingEntityID)
{ receivingEntityID = pReceivingEntityID;
}
// 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_receivingEntityID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_receivingEntityID")
public EntityID getReceivingEntityID()
{ return receivingEntityID;
}
public void setSupplyingEntityID(EntityID pSupplyingEntityID)
{ supplyingEntityID = pSupplyingEntityID;
}
// 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_supplyingEntityID;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_supplyingEntityID")
public EntityID getSupplyingEntityID()
{ return supplyingEntityID;
}
@XmlAttribute
@Basic
public short getNumberOfSupplyTypes()
{ return (short)supplies.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfSupplyTypes 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 setNumberOfSupplyTypes(short pNumberOfSupplyTypes)
{ numberOfSupplyTypes = pNumberOfSupplyTypes;
}
public void setPadding1(short pPadding1)
{ padding1 = pPadding1;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public short getPadding1()
{ return padding1;
}
public void setPadding2(byte pPadding2)
{ padding2 = pPadding2;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public byte getPadding2()
{ return padding2;
}
public void setSupplies(List pSupplies)
{ supplies = pSupplies;
}
@XmlElementWrapper(name="suppliesList" ) // Jaxb
@OneToMany // Hibernate
public List getSupplies()
{ return supplies; }
public void marshal(DataOutputStream dos)
{
super.marshal(dos);
try
{
receivingEntityID.marshal(dos);
supplyingEntityID.marshal(dos);
dos.writeByte( (byte)supplies.size());
dos.writeShort( (short)padding1);
dos.writeByte( (byte)padding2);
for(int idx = 0; idx < supplies.size(); idx++)
{
SupplyQuantity aSupplyQuantity = supplies.get(idx);
aSupplyQuantity.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
{
receivingEntityID.unmarshal(dis);
supplyingEntityID.unmarshal(dis);
numberOfSupplyTypes = (short)dis.readUnsignedByte();
padding1 = dis.readShort();
padding2 = dis.readByte();
for(int idx = 0; idx < numberOfSupplyTypes; idx++)
{
SupplyQuantity anX = new SupplyQuantity();
anX.unmarshal(dis);
supplies.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);
receivingEntityID.marshal(buff);
supplyingEntityID.marshal(buff);
buff.put( (byte)supplies.size());
buff.putShort( (short)padding1);
buff.put( (byte)padding2);
for(int idx = 0; idx < supplies.size(); idx++)
{
SupplyQuantity aSupplyQuantity = (SupplyQuantity)supplies.get(idx);
aSupplyQuantity.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);
receivingEntityID.unmarshal(buff);
supplyingEntityID.unmarshal(buff);
numberOfSupplyTypes = (short)(buff.get() & 0xFF);
padding1 = buff.getShort();
padding2 = buff.get();
for(int idx = 0; idx < numberOfSupplyTypes; idx++)
{
SupplyQuantity anX = new SupplyQuantity();
anX.unmarshal(buff);
supplies.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 ResupplyReceivedPdu))
return false;
final ResupplyReceivedPdu rhs = (ResupplyReceivedPdu)obj;
if( ! (receivingEntityID.equals( rhs.receivingEntityID) )) ivarsEqual = false;
if( ! (supplyingEntityID.equals( rhs.supplyingEntityID) )) ivarsEqual = false;
if( ! (numberOfSupplyTypes == rhs.numberOfSupplyTypes)) ivarsEqual = false;
if( ! (padding1 == rhs.padding1)) ivarsEqual = false;
if( ! (padding2 == rhs.padding2)) ivarsEqual = false;
for(int idx = 0; idx < supplies.size(); idx++)
{
if( ! ( supplies.get(idx).equals(rhs.supplies.get(idx)))) ivarsEqual = false;
}
return ivarsEqual && super.equalsImpl(rhs);
}
} // end of class