edu.nps.moves.dis.PduContainer 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
/**
* Used for XML compatability. A container that holds PDUs
*
* 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
*/
@XmlRootElement
@Entity // Hibernate
@Inheritance(strategy=InheritanceType.JOINED) // Hibernate
public class PduContainer extends Object implements Serializable
{
/** Primary key for hibernate, not part of the DIS standard */
private long pk_PduContainer;
/** Number of PDUs in the container list */
protected int numberOfPdus;
/** record sets */
protected List< Pdu> pdus = new ArrayList();
/** Constructor */
public PduContainer()
{
}
@Transient // Marked as transient to prevent hibernate from thinking this is a persistent property
public int getMarshalledSize()
{
int marshalSize = 0;
marshalSize = marshalSize + 4; // numberOfPdus
for(int idx=0; idx < pdus.size(); idx++)
{
Pdu listElement = pdus.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
/** Primary key for hibernate, not part of the DIS standard */
@Id
@GeneratedValue(strategy=GenerationType.AUTO)
public long getPk_PduContainer()
{
return pk_PduContainer;
}
/** Hibernate primary key, not part of the DIS standard */
public void setPk_PduContainer(long pKeyName)
{
this.pk_PduContainer = pKeyName;
}
@XmlAttribute
@Basic
public int getNumberOfPdus()
{ return (int)pdus.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfPdus 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 setNumberOfPdus(int pNumberOfPdus)
{ numberOfPdus = pNumberOfPdus;
}
public void setPdus(List pPdus)
{ pdus = pPdus;
}
@XmlElementWrapper(name="pdusList" ) // Jaxb
@OneToMany // Hibernate
public List getPdus()
{ return pdus; }
public void marshal(DataOutputStream dos)
{
try
{
dos.writeInt( (int)pdus.size());
for(int idx = 0; idx < pdus.size(); idx++)
{
Pdu aPdu = pdus.get(idx);
aPdu.marshal(dos);
} // end of list marshalling
} // end try
catch(Exception e)
{
System.out.println(e);}
} // end of marshal method
public void unmarshal(DataInputStream dis)
{
try
{
numberOfPdus = dis.readInt();
for(int idx = 0; idx < numberOfPdus; idx++)
{
Pdu anX = new Pdu();
anX.unmarshal(dis);
pdus.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)
{
buff.putInt( (int)pdus.size());
for(int idx = 0; idx < pdus.size(); idx++)
{
Pdu aPdu = (Pdu)pdus.get(idx);
aPdu.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)
{
numberOfPdus = buff.getInt();
for(int idx = 0; idx < numberOfPdus; idx++)
{
Pdu anX = new Pdu();
anX.unmarshal(buff);
pdus.add(anX);
}
} // end of unmarshal method
/**
* JAXB marshalls (by default) only classes that are marked with @XmlRootElement.
* This is a convienience method for marshalling the top level root element.
* Note that this requires the presence of jaxb.index in the package directory.
*/
public void marshallToXml(String filename)
{
try
{
JAXBContext context = JAXBContext.newInstance();
Marshaller marshaller = context.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.marshal(this, new FileOutputStream(filename));
} // End try
catch(Exception e) {System.out.println(e);
};
}
/*
* 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);
}
/**
* Compare all fields that contribute to the state, ignoring
transient and static fields, for this and the supplied object
* @param obj the object to compare to
* @return true if the objects are equal, false otherwise.
*/
public boolean equalsImpl(Object obj)
{
boolean ivarsEqual = true;
if(!(obj instanceof PduContainer))
return false;
final PduContainer rhs = (PduContainer)obj;
if( ! (numberOfPdus == rhs.numberOfPdus)) ivarsEqual = false;
for(int idx = 0; idx < pdus.size(); idx++)
{
if( ! ( pdus.get(idx).equals(rhs.pdus.get(idx)))) ivarsEqual = false;
}
return ivarsEqual;
}
} // end of class