edu.nps.moves.dis.AcousticEmitterSystemData 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 in the UA pdu; ties together an emmitter and a location. This requires manual cleanup; the beam data should not be attached to each emitter system.
*
* 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 AcousticEmitterSystemData extends Object implements Serializable
{
/** Primary key for hibernate, not part of the DIS standard */
private long pk_AcousticEmitterSystemData;
/** Length of emitter system data */
protected short emitterSystemDataLength;
/** Number of beams */
protected short numberOfBeams;
/** padding */
protected int pad2;
/** This field shall specify the system for a particular UA emitter. */
protected AcousticEmitterSystem acousticEmitterSystem = new AcousticEmitterSystem();
/** Represents the location wrt the entity */
protected Vector3Float emitterLocation = new Vector3Float();
/** For each beam in numberOfBeams, an emitter system. This is not right--the beam records need to be at the end of the PDU, rather than attached to each system. */
protected List< AcousticBeamData> beamRecords = new ArrayList();
/** Constructor */
public AcousticEmitterSystemData()
{
}
@Transient // Marked as transient to prevent hibernate from thinking this is a persistent property
public int getMarshalledSize()
{
int marshalSize = 0;
marshalSize = marshalSize + 1; // emitterSystemDataLength
marshalSize = marshalSize + 1; // numberOfBeams
marshalSize = marshalSize + 2; // pad2
marshalSize = marshalSize + acousticEmitterSystem.getMarshalledSize(); // acousticEmitterSystem
marshalSize = marshalSize + emitterLocation.getMarshalledSize(); // emitterLocation
for(int idx=0; idx < beamRecords.size(); idx++)
{
AcousticBeamData listElement = beamRecords.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_AcousticEmitterSystemData()
{
return pk_AcousticEmitterSystemData;
}
/** Hibernate primary key, not part of the DIS standard */
public void setPk_AcousticEmitterSystemData(long pKeyName)
{
this.pk_AcousticEmitterSystemData = pKeyName;
}
public void setEmitterSystemDataLength(short pEmitterSystemDataLength)
{ emitterSystemDataLength = pEmitterSystemDataLength;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public short getEmitterSystemDataLength()
{ return emitterSystemDataLength;
}
@XmlAttribute
@Basic
public short getNumberOfBeams()
{ return (short)beamRecords.size();
}
/** Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
* The getnumberOfBeams 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 setNumberOfBeams(short pNumberOfBeams)
{ numberOfBeams = pNumberOfBeams;
}
public void setPad2(int pPad2)
{ pad2 = pPad2;
}
@XmlAttribute // Jaxb
@Basic // Hibernate
public int getPad2()
{ return pad2;
}
public void setAcousticEmitterSystem(AcousticEmitterSystem pAcousticEmitterSystem)
{ acousticEmitterSystem = pAcousticEmitterSystem;
}
// 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_acousticEmitterSystem;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_acousticEmitterSystem")
public AcousticEmitterSystem getAcousticEmitterSystem()
{ return acousticEmitterSystem;
}
public void setEmitterLocation(Vector3Float pEmitterLocation)
{ emitterLocation = pEmitterLocation;
}
// 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_emitterLocation;
@XmlElement
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="fk_emitterLocation")
public Vector3Float getEmitterLocation()
{ return emitterLocation;
}
public void setBeamRecords(List pBeamRecords)
{ beamRecords = pBeamRecords;
}
@XmlElementWrapper(name="beamRecordsList" ) // Jaxb
@OneToMany // Hibernate
public List getBeamRecords()
{ return beamRecords; }
public void marshal(DataOutputStream dos)
{
try
{
dos.writeByte( (byte)emitterSystemDataLength);
dos.writeByte( (byte)beamRecords.size());
dos.writeShort( (short)pad2);
acousticEmitterSystem.marshal(dos);
emitterLocation.marshal(dos);
for(int idx = 0; idx < beamRecords.size(); idx++)
{
AcousticBeamData aAcousticBeamData = beamRecords.get(idx);
aAcousticBeamData.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
{
emitterSystemDataLength = (short)dis.readUnsignedByte();
numberOfBeams = (short)dis.readUnsignedByte();
pad2 = (int)dis.readUnsignedShort();
acousticEmitterSystem.unmarshal(dis);
emitterLocation.unmarshal(dis);
for(int idx = 0; idx < numberOfBeams; idx++)
{
AcousticBeamData anX = new AcousticBeamData();
anX.unmarshal(dis);
beamRecords.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.put( (byte)emitterSystemDataLength);
buff.put( (byte)beamRecords.size());
buff.putShort( (short)pad2);
acousticEmitterSystem.marshal(buff);
emitterLocation.marshal(buff);
for(int idx = 0; idx < beamRecords.size(); idx++)
{
AcousticBeamData aAcousticBeamData = (AcousticBeamData)beamRecords.get(idx);
aAcousticBeamData.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)
{
emitterSystemDataLength = (short)(buff.get() & 0xFF);
numberOfBeams = (short)(buff.get() & 0xFF);
pad2 = (int)(buff.getShort() & 0xFFFF);
acousticEmitterSystem.unmarshal(buff);
emitterLocation.unmarshal(buff);
for(int idx = 0; idx < numberOfBeams; idx++)
{
AcousticBeamData anX = new AcousticBeamData();
anX.unmarshal(buff);
beamRecords.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);
}
/**
* 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 AcousticEmitterSystemData))
return false;
final AcousticEmitterSystemData rhs = (AcousticEmitterSystemData)obj;
if( ! (emitterSystemDataLength == rhs.emitterSystemDataLength)) ivarsEqual = false;
if( ! (numberOfBeams == rhs.numberOfBeams)) ivarsEqual = false;
if( ! (pad2 == rhs.pad2)) ivarsEqual = false;
if( ! (acousticEmitterSystem.equals( rhs.acousticEmitterSystem) )) ivarsEqual = false;
if( ! (emitterLocation.equals( rhs.emitterLocation) )) ivarsEqual = false;
for(int idx = 0; idx < beamRecords.size(); idx++)
{
if( ! ( beamRecords.get(idx).equals(rhs.beamRecords.get(idx)))) ivarsEqual = false;
}
return ivarsEqual;
}
} // end of class