edu.nps.moves.dis.EventReportReliablePdu 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.12.11: reports the occurance of a significatnt event to the simulation manager. Needs manual intervention to fix padding in variable datums. 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 EventReportReliablePdu extends SimulationManagementWithReliabilityFamilyPdu implements Serializable
{
/** Event type */
protected int eventType;
/** padding */
protected long pad1;
/** Fixed datum record count */
protected long numberOfFixedDatumRecords;
/** variable datum record count */
protected long numberOfVariableDatumRecords;
/** Fixed datum records */
protected List< FixedDatum> fixedDatumRecords = new ArrayList();
/** Variable datum records */
protected List< VariableDatum> variableDatumRecords = new ArrayList();
/** Constructor */
public EventReportReliablePdu()
{
setPduType( (short)61 );
}
@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 + 2; // eventType
marshalSize = marshalSize + 4; // pad1
marshalSize = marshalSize + 4; // numberOfFixedDatumRecords
marshalSize = marshalSize + 4; // numberOfVariableDatumRecords
for(int idx=0; idx < fixedDatumRecords.size(); idx++)
{
FixedDatum listElement = fixedDatumRecords.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
for(int idx=0; idx < variableDatumRecords.size(); idx++)
{
VariableDatum listElement = variableDatumRecords.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
public void setEventType(int pEventType)
{ eventType = pEventType;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public int getEventType()
{ return eventType;
}
public void setPad1(long pPad1)
{ pad1 = pPad1;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public long getPad1()
{ return pad1;
}
@XmlAttribute
@Basic
public long getNumberOfFixedDatumRecords()
{ return (long)fixedDatumRecords.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfFixedDatumRecords 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 setNumberOfFixedDatumRecords(long pNumberOfFixedDatumRecords)
{ numberOfFixedDatumRecords = pNumberOfFixedDatumRecords;
}
@XmlAttribute
@Basic
public long getNumberOfVariableDatumRecords()
{ return (long)variableDatumRecords.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfVariableDatumRecords 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 setNumberOfVariableDatumRecords(long pNumberOfVariableDatumRecords)
{ numberOfVariableDatumRecords = pNumberOfVariableDatumRecords;
}
public void setFixedDatumRecords(List pFixedDatumRecords)
{ fixedDatumRecords = pFixedDatumRecords;
}
@XmlElementWrapper(name="fixedDatumRecordsList" ) // Jaxb
@OneToMany // Hibernate
public List getFixedDatumRecords()
{ return fixedDatumRecords; }
public void setVariableDatumRecords(List pVariableDatumRecords)
{ variableDatumRecords = pVariableDatumRecords;
}
@XmlElementWrapper(name="variableDatumRecordsList" ) // Jaxb
@OneToMany // Hibernate
public List getVariableDatumRecords()
{ return variableDatumRecords; }
public void marshal(DataOutputStream dos)
{
super.marshal(dos);
try
{
dos.writeShort( (short)eventType);
dos.writeInt( (int)pad1);
dos.writeInt( (int)fixedDatumRecords.size());
dos.writeInt( (int)variableDatumRecords.size());
for(int idx = 0; idx < fixedDatumRecords.size(); idx++)
{
FixedDatum aFixedDatum = fixedDatumRecords.get(idx);
aFixedDatum.marshal(dos);
} // end of list marshalling
for(int idx = 0; idx < variableDatumRecords.size(); idx++)
{
VariableDatum aVariableDatum = variableDatumRecords.get(idx);
aVariableDatum.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
{
eventType = (int)dis.readUnsignedShort();
pad1 = dis.readInt();
numberOfFixedDatumRecords = dis.readInt();
numberOfVariableDatumRecords = dis.readInt();
for(int idx = 0; idx < numberOfFixedDatumRecords; idx++)
{
FixedDatum anX = new FixedDatum();
anX.unmarshal(dis);
fixedDatumRecords.add(anX);
}
for(int idx = 0; idx < numberOfVariableDatumRecords; idx++)
{
VariableDatum anX = new VariableDatum();
anX.unmarshal(dis);
variableDatumRecords.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);
buff.putShort( (short)eventType);
buff.putInt( (int)pad1);
buff.putInt( (int)fixedDatumRecords.size());
buff.putInt( (int)variableDatumRecords.size());
for(int idx = 0; idx < fixedDatumRecords.size(); idx++)
{
FixedDatum aFixedDatum = (FixedDatum)fixedDatumRecords.get(idx);
aFixedDatum.marshal(buff);
} // end of list marshalling
for(int idx = 0; idx < variableDatumRecords.size(); idx++)
{
VariableDatum aVariableDatum = (VariableDatum)variableDatumRecords.get(idx);
aVariableDatum.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);
eventType = (int)(buff.getShort() & 0xFFFF);
pad1 = buff.getInt();
numberOfFixedDatumRecords = buff.getInt();
numberOfVariableDatumRecords = buff.getInt();
for(int idx = 0; idx < numberOfFixedDatumRecords; idx++)
{
FixedDatum anX = new FixedDatum();
anX.unmarshal(buff);
fixedDatumRecords.add(anX);
}
for(int idx = 0; idx < numberOfVariableDatumRecords; idx++)
{
VariableDatum anX = new VariableDatum();
anX.unmarshal(buff);
variableDatumRecords.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 EventReportReliablePdu))
return false;
final EventReportReliablePdu rhs = (EventReportReliablePdu)obj;
if( ! (eventType == rhs.eventType)) ivarsEqual = false;
if( ! (pad1 == rhs.pad1)) ivarsEqual = false;
if( ! (numberOfFixedDatumRecords == rhs.numberOfFixedDatumRecords)) ivarsEqual = false;
if( ! (numberOfVariableDatumRecords == rhs.numberOfVariableDatumRecords)) ivarsEqual = false;
for(int idx = 0; idx < fixedDatumRecords.size(); idx++)
{
if( ! ( fixedDatumRecords.get(idx).equals(rhs.fixedDatumRecords.get(idx)))) ivarsEqual = false;
}
for(int idx = 0; idx < variableDatumRecords.size(); idx++)
{
if( ! ( variableDatumRecords.get(idx).equals(rhs.variableDatumRecords.get(idx)))) ivarsEqual = false;
}
return ivarsEqual && super.equalsImpl(rhs);
}
} // end of class