edu.nps.moves.dis.EntityStatePdu Maven / Gradle / Ivy
package edu.nps.moves.dis;
import java.util.*;
import java.io.*;
/**
* Section 5.3.3.1. Represents the postion and state of one entity in the world.
* COMPLETE
*
* Copyright (c) 2008-2016, 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
*/
public class EntityStatePdu extends EntityInformationFamilyPdu implements Serializable {
/**
* Unique ID for an entity that is tied to this state information
*/
protected EntityID entityID = new EntityID();
/**
* What force this entity is affiliated with, eg red, blue, neutral, etc
*/
protected short forceId;
/**
* How many articulation parameters are in the variable length list
*/
protected byte numberOfArticulationParameters;
/**
* Describes the type of entity in the world
*/
protected EntityType entityType = new EntityType();
protected EntityType alternativeEntityType = new EntityType();
/**
* Describes the speed of the entity in the world
*/
protected Vector3Float entityLinearVelocity = new Vector3Float();
/**
* describes the location of the entity in the world
*/
protected Vector3Double entityLocation = new Vector3Double();
/**
* describes the orientation of the entity, in euler angles
*/
protected Orientation entityOrientation = new Orientation();
/**
* a series of bit flags that are used to help draw the entity, such as
* smoking, on fire, etc.
*/
protected int entityAppearance = 0;
/**
* parameters used for dead reckoning
*/
protected DeadReckoningParameter deadReckoningParameters = new DeadReckoningParameter();
/**
* characters that can be used for debugging, or to draw unique strings on
* the side of entities in the world
*/
protected Marking marking = new Marking();
/**
* a series of bit flags
*/
protected int capabilities = 0;
/**
* variable length list of articulation parameters
*/
protected List< ArticulationParameter> articulationParameters = new ArrayList< ArticulationParameter>();
/**
* Constructor
*/
public EntityStatePdu() {
setPduType((short) 1);
}
public int getMarshalledSize() {
int marshalSize = 0;
marshalSize = super.getMarshalledSize();
marshalSize = marshalSize + entityID.getMarshalledSize(); // entityID
marshalSize = marshalSize + 1; // forceId
marshalSize = marshalSize + 1; // numberOfArticulationParameters
marshalSize = marshalSize + entityType.getMarshalledSize(); // entityType
marshalSize = marshalSize + alternativeEntityType.getMarshalledSize(); // alternativeEntityType
marshalSize = marshalSize + entityLinearVelocity.getMarshalledSize(); // entityLinearVelocity
marshalSize = marshalSize + entityLocation.getMarshalledSize(); // entityLocation
marshalSize = marshalSize + entityOrientation.getMarshalledSize(); // entityOrientation
marshalSize = marshalSize + 4; // entityAppearance
marshalSize = marshalSize + deadReckoningParameters.getMarshalledSize(); // deadReckoningParameters
marshalSize = marshalSize + marking.getMarshalledSize(); // marking
marshalSize = marshalSize + 4; // capabilities
for (int idx = 0; idx < articulationParameters.size(); idx++) {
ArticulationParameter listElement = articulationParameters.get(idx);
marshalSize = marshalSize + listElement.getMarshalledSize();
}
return marshalSize;
}
public void setEntityID(EntityID pEntityID) {
entityID = pEntityID;
}
public EntityID getEntityID() {
return entityID;
}
public void setForceId(short pForceId) {
forceId = pForceId;
}
public short getForceId() {
return forceId;
}
public byte getNumberOfArticulationParameters() {
return (byte) articulationParameters.size();
}
/**
* Note that setting this value will not change the marshalled value. The
* list whose length this describes is used for that purpose. The
* getnumberOfArticulationParameters 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 setNumberOfArticulationParameters(byte pNumberOfArticulationParameters) {
numberOfArticulationParameters = pNumberOfArticulationParameters;
}
public void setEntityType(EntityType pEntityType) {
entityType = pEntityType;
}
public EntityType getEntityType() {
return entityType;
}
public void setAlternativeEntityType(EntityType pAlternativeEntityType) {
alternativeEntityType = pAlternativeEntityType;
}
public EntityType getAlternativeEntityType() {
return alternativeEntityType;
}
public void setEntityLinearVelocity(Vector3Float pEntityLinearVelocity) {
entityLinearVelocity = pEntityLinearVelocity;
}
public Vector3Float getEntityLinearVelocity() {
return entityLinearVelocity;
}
public void setEntityLocation(Vector3Double pEntityLocation) {
entityLocation = pEntityLocation;
}
public Vector3Double getEntityLocation() {
return entityLocation;
}
public void setEntityOrientation(Orientation pEntityOrientation) {
entityOrientation = pEntityOrientation;
}
public Orientation getEntityOrientation() {
return entityOrientation;
}
public void setEntityAppearance(int pEntityAppearance) {
entityAppearance = pEntityAppearance;
}
public int getEntityAppearance() {
return entityAppearance;
}
public void setDeadReckoningParameters(DeadReckoningParameter pDeadReckoningParameters) {
deadReckoningParameters = pDeadReckoningParameters;
}
public DeadReckoningParameter getDeadReckoningParameters() {
return deadReckoningParameters;
}
public void setMarking(Marking pMarking) {
marking = pMarking;
}
public Marking getMarking() {
return marking;
}
public void setCapabilities(int pCapabilities) {
capabilities = pCapabilities;
}
public int getCapabilities() {
return capabilities;
}
public void setArticulationParameters(List pArticulationParameters) {
articulationParameters = pArticulationParameters;
}
public List getArticulationParameters() {
return articulationParameters;
}
/**
* 0 uniform color, 1 camouflage
*/
public int getEntityAppearance_paintScheme() {
int val = (int) (this.entityAppearance & (int) 0x1);
return (int) (val >> 0);
}
/**
* 0 uniform color, 1 camouflage
*/
public void setEntityAppearance_paintScheme(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x1); // clear bits
aVal = (int) (val << 0);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 no mobility kill, 1 mobility kill
*/
public int getEntityAppearance_mobility() {
int val = (int) (this.entityAppearance & (int) 0x2);
return (int) (val >> 1);
}
/**
* 0 no mobility kill, 1 mobility kill
*/
public void setEntityAppearance_mobility(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x2); // clear bits
aVal = (int) (val << 1);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 no firepower iill, 1 firepower kill
*/
public int getEntityAppearance_firepower() {
int val = (int) (this.entityAppearance & (int) 0x4);
return (int) (val >> 2);
}
/**
* 0 no firepower iill, 1 firepower kill
*/
public void setEntityAppearance_firepower(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x4); // clear bits
aVal = (int) (val << 2);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 no damage, 1 slight damage, 2 moderate, 3 destroyed
*/
public int getEntityAppearance_damage() {
int val = (int) (this.entityAppearance & (int) 0x18);
return (int) (val >> 3);
}
/**
* 0 no damage, 1 slight damage, 2 moderate, 3 destroyed
*/
public void setEntityAppearance_damage(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x18); // clear bits
aVal = (int) (val << 3);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 no smoke, 1 smoke plume, 2 engine smoke, 3 engine smoke and plume
*/
public int getEntityAppearance_smoke() {
int val = (int) (this.entityAppearance & (int) 0x60);
return (int) (val >> 5);
}
/**
* 0 no smoke, 1 smoke plume, 2 engine smoke, 3 engine smoke and plume
*/
public void setEntityAppearance_smoke(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x60); // clear bits
aVal = (int) (val << 5);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* dust cloud, 0 none 1 small 2 medium 3 large
*/
public int getEntityAppearance_trailingEffects() {
int val = (int) (this.entityAppearance & (int) 0x180);
return (int) (val >> 7);
}
/**
* dust cloud, 0 none 1 small 2 medium 3 large
*/
public void setEntityAppearance_trailingEffects(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x180); // clear bits
aVal = (int) (val << 7);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 NA 1 closed popped 3 popped and person visible 4 open 5 open and person
* visible
*/
public int getEntityAppearance_hatch() {
int val = (int) (this.entityAppearance & (int) 0xe00);
return (int) (val >> 9);
}
/**
* 0 NA 1 closed popped 3 popped and person visible 4 open 5 open and person
* visible
*/
public void setEntityAppearance_hatch(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0xe00); // clear bits
aVal = (int) (val << 9);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 off 1 on
*/
public int getEntityAppearance_headlights() {
int val = (int) (this.entityAppearance & (int) 0x1000);
return (int) (val >> 12);
}
/**
* 0 off 1 on
*/
public void setEntityAppearance_headlights(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x1000); // clear bits
aVal = (int) (val << 12);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 off 1 on
*/
public int getEntityAppearance_tailLights() {
int val = (int) (this.entityAppearance & (int) 0x2000);
return (int) (val >> 13);
}
/**
* 0 off 1 on
*/
public void setEntityAppearance_tailLights(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x2000); // clear bits
aVal = (int) (val << 13);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 off 1 on
*/
public int getEntityAppearance_brakeLights() {
int val = (int) (this.entityAppearance & (int) 0x4000);
return (int) (val >> 14);
}
/**
* 0 off 1 on
*/
public void setEntityAppearance_brakeLights(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x4000); // clear bits
aVal = (int) (val << 14);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 off 1 on
*/
public int getEntityAppearance_flaming() {
int val = (int) (this.entityAppearance & (int) 0x8000);
return (int) (val >> 15);
}
/**
* 0 off 1 on
*/
public void setEntityAppearance_flaming(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x8000); // clear bits
aVal = (int) (val << 15);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 not raised 1 raised
*/
public int getEntityAppearance_launcher() {
int val = (int) (this.entityAppearance & (int) 0x10000);
return (int) (val >> 16);
}
/**
* 0 not raised 1 raised
*/
public void setEntityAppearance_launcher(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x10000); // clear bits
aVal = (int) (val << 16);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 0 desert 1 winter 2 forest 3 unused
*/
public int getEntityAppearance_camouflageType() {
int val = (int) (this.entityAppearance & (int) 0x60000);
return (int) (val >> 17);
}
/**
* 0 desert 1 winter 2 forest 3 unused
*/
public void setEntityAppearance_camouflageType(int val) {
int aVal = 0;
this.entityAppearance &= (int) (~0x60000); // clear bits
aVal = (int) (val << 17);
this.entityAppearance = (int) (this.entityAppearance | aVal);
}
/**
* 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);
entityID.marshal(buff);
buff.put((byte) forceId);
buff.put((byte) articulationParameters.size());
entityType.marshal(buff);
alternativeEntityType.marshal(buff);
entityLinearVelocity.marshal(buff);
entityLocation.marshal(buff);
entityOrientation.marshal(buff);
buff.putInt((int) entityAppearance);
deadReckoningParameters.marshal(buff);
marking.marshal(buff);
buff.putInt((int) capabilities);
for (int idx = 0; idx < articulationParameters.size(); idx++) {
ArticulationParameter aArticulationParameter = (ArticulationParameter) articulationParameters.get(idx);
aArticulationParameter.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);
entityID.unmarshal(buff);
forceId = (short) (buff.get() & 0xFF);
numberOfArticulationParameters = buff.get();
entityType.unmarshal(buff);
alternativeEntityType.unmarshal(buff);
entityLinearVelocity.unmarshal(buff);
entityLocation.unmarshal(buff);
entityOrientation.unmarshal(buff);
entityAppearance = buff.getInt();
deadReckoningParameters.unmarshal(buff);
marking.unmarshal(buff);
capabilities = buff.getInt();
for (int idx = 0; idx < numberOfArticulationParameters; idx++) {
ArticulationParameter anX = new ArticulationParameter();
anX.unmarshal(buff);
articulationParameters.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 EntityStatePdu)) {
return false;
}
final EntityStatePdu rhs = (EntityStatePdu) obj;
if (!(entityID.equals(rhs.entityID))) {
ivarsEqual = false;
}
if (!(forceId == rhs.forceId)) {
ivarsEqual = false;
}
if (!(numberOfArticulationParameters == rhs.numberOfArticulationParameters)) {
ivarsEqual = false;
}
if (!(entityType.equals(rhs.entityType))) {
ivarsEqual = false;
}
if (!(alternativeEntityType.equals(rhs.alternativeEntityType))) {
ivarsEqual = false;
}
if (!(entityLinearVelocity.equals(rhs.entityLinearVelocity))) {
ivarsEqual = false;
}
if (!(entityLocation.equals(rhs.entityLocation))) {
ivarsEqual = false;
}
if (!(entityOrientation.equals(rhs.entityOrientation))) {
ivarsEqual = false;
}
if (!(entityAppearance == rhs.entityAppearance)) {
ivarsEqual = false;
}
if (!(deadReckoningParameters.equals(rhs.deadReckoningParameters))) {
ivarsEqual = false;
}
if (!(marking.equals(rhs.marking))) {
ivarsEqual = false;
}
if (!(capabilities == rhs.capabilities)) {
ivarsEqual = false;
}
for (int idx = 0; idx < articulationParameters.size(); idx++) {
if (!(articulationParameters.get(idx).equals(rhs.articulationParameters.get(idx)))) {
ivarsEqual = false;
}
}
return ivarsEqual && super.equalsImpl(rhs);
}
} // end of class
© 2015 - 2025 Weber Informatics LLC | Privacy Policy