edu.nps.moves.dis
Class MinefieldStatePdu

java.lang.Object
  edu.nps.moves.dis.Pdu
      edu.nps.moves.dis.MinefieldFamilyPdu
          edu.nps.moves.dis.MinefieldStatePdu

All Implemented Interfaces:

java.io.Serializable

@Entity
public class MinefieldStatePdu
extends MinefieldFamilyPdu
implements java.io.Serializable

Section 5.3.10.1 Abstract superclass for PDUs relating to minefields. 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

See Also:

Serialized Form

Field Summary

protected int	appearance appearance bitflags
long	fk_minefieldID
long	fk_minefieldLocation
long	fk_minefieldOrientation
long	fk_minefieldType
protected short	forceID force ID
protected EntityID	minefieldID Minefield ID
protected Vector3Double	minefieldLocation location of minefield in world coords
protected Orientation	minefieldOrientation orientation of minefield
protected int	minefieldSequence Minefield sequence
protected EntityType	minefieldType type of minefield
protected java.util.List<EntityType>	mineType Type of mines
protected int	numberOfMineTypes how many mine types
protected short	numberOfPerimeterPoints Number of permieter points
protected java.util.List<Point>	perimeterPoints perimeter points for the minefield
protected int	protocolMode protocolMode

Fields inherited from class edu.nps.moves.dis.Pdu

exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

MinefieldStatePdu()
Constructor

Method Summary

boolean	equals(java.lang.Object obj)
boolean	equalsImpl(java.lang.Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
int	getAppearance()
short	getForceID()
int	getMarshalledSize()
EntityID	getMinefieldID()
Vector3Double	getMinefieldLocation()
Orientation	getMinefieldOrientation()
int	getMinefieldSequence()
EntityType	getMinefieldType()
java.util.List<EntityType>	getMineType()
int	getNumberOfMineTypes()
short	getNumberOfPerimeterPoints()
java.util.List<Point>	getPerimeterPoints()
int	getProtocolMode()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setAppearance(int pAppearance)
void	setForceID(short pForceID)
void	setMinefieldID(EntityID pMinefieldID)
void	setMinefieldLocation(Vector3Double pMinefieldLocation)
void	setMinefieldOrientation(Orientation pMinefieldOrientation)
void	setMinefieldSequence(int pMinefieldSequence)
void	setMinefieldType(EntityType pMinefieldType)
void	setMineType(java.util.List<EntityType> pMineType)
void	setNumberOfMineTypes(int pNumberOfMineTypes) Note that setting this value will not change the marshalled value.
void	setNumberOfPerimeterPoints(short pNumberOfPerimeterPoints) Note that setting this value will not change the marshalled value.
void	setPerimeterPoints(java.util.List<Point> pPerimeterPoints)
void	setProtocolMode(int pProtocolMode)
void	unmarshal(java.nio.ByteBuffer buff) Unpacks a Pdu from the underlying data.
void	unmarshal(java.io.DataInputStream dis)

Methods inherited from class edu.nps.moves.dis.Pdu

getExerciseID, getLength, getPadding, getPduLength, getPduType, getPduTypeEnum, getPk_Pdu, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setPk_Pdu, setProtocolFamily, setProtocolVersion, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minefieldID

protected EntityID minefieldID

Minefield ID

minefieldSequence

protected int minefieldSequence

Minefield sequence

forceID

protected short forceID

force ID

numberOfPerimeterPoints

protected short numberOfPerimeterPoints

Number of permieter points

minefieldType

protected EntityType minefieldType

type of minefield

numberOfMineTypes

protected int numberOfMineTypes

how many mine types

minefieldLocation

protected Vector3Double minefieldLocation

location of minefield in world coords

minefieldOrientation

protected Orientation minefieldOrientation

orientation of minefield

appearance

protected int appearance

appearance bitflags

protocolMode

protected int protocolMode

protocolMode

perimeterPoints

protected java.util.List<Point> perimeterPoints

perimeter points for the minefield

mineType

protected java.util.List<EntityType> mineType

Type of mines

fk_minefieldID

public long fk_minefieldID

fk_minefieldType

public long fk_minefieldType

fk_minefieldLocation

public long fk_minefieldLocation

fk_minefieldOrientation

public long fk_minefieldOrientation

Constructor Detail

MinefieldStatePdu

public MinefieldStatePdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class MinefieldFamilyPdu

setMinefieldID

public void setMinefieldID(EntityID pMinefieldID)

getMinefieldID

public EntityID getMinefieldID()

setMinefieldSequence

public void setMinefieldSequence(int pMinefieldSequence)

getMinefieldSequence

public int getMinefieldSequence()

setForceID

public void setForceID(short pForceID)

getForceID

public short getForceID()

getNumberOfPerimeterPoints

public short getNumberOfPerimeterPoints()

setNumberOfPerimeterPoints

public void setNumberOfPerimeterPoints(short pNumberOfPerimeterPoints)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfPerimeterPoints method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

setMinefieldType

public void setMinefieldType(EntityType pMinefieldType)

getMinefieldType

public EntityType getMinefieldType()

getNumberOfMineTypes

public int getNumberOfMineTypes()

setNumberOfMineTypes

public void setNumberOfMineTypes(int pNumberOfMineTypes)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfMineTypes method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

setMinefieldLocation

public void setMinefieldLocation(Vector3Double pMinefieldLocation)

getMinefieldLocation

public Vector3Double getMinefieldLocation()

setMinefieldOrientation

public void setMinefieldOrientation(Orientation pMinefieldOrientation)

getMinefieldOrientation

public Orientation getMinefieldOrientation()

setAppearance

public void setAppearance(int pAppearance)

getAppearance

public int getAppearance()

setProtocolMode

public void setProtocolMode(int pProtocolMode)

getProtocolMode

public int getProtocolMode()

setPerimeterPoints

public void setPerimeterPoints(java.util.List<Point> pPerimeterPoints)

getPerimeterPoints

public java.util.List<Point> getPerimeterPoints()

setMineType

public void setMineType(java.util.List<EntityType> pMineType)

getMineType

public java.util.List<EntityType> getMineType()

marshal

public void marshal(java.io.DataOutputStream dos)

Overrides:

marshal in class MinefieldFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)

Overrides:

unmarshal in class MinefieldFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

Overrides:

marshal in class MinefieldFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin writing

Throws:

java.nio.BufferOverflowException - if buff is too small

java.nio.ReadOnlyBufferException - if buff is read only

Since:

??

See Also:

ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)

Unpacks a Pdu from the underlying data.

Overrides:

unmarshal in class MinefieldFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin reading

Throws:

java.nio.BufferUnderflowException - if buff is too small

Since:

??

See Also:

ByteBuffer

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class MinefieldFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.Object obj)

Description copied from class: Pdu

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class MinefieldFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.