edu.nps.moves.dismobile
Class TransferControlRequestPdu

java.lang.Object
  edu.nps.moves.dismobile.Pdu
      edu.nps.moves.dismobile.EntityManagementFamilyPdu
          edu.nps.moves.dismobile.TransferControlRequestPdu

All Implemented Interfaces:

java.io.Serializable

public class TransferControlRequestPdu
extends EntityManagementFamilyPdu
implements java.io.Serializable

Section 5.3.9.3 Information initiating the dyanic allocation and control of simulation entities between two simulation applications. Requires manual cleanup. The padding between record sets is variable. 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

See Also:

Serialized Form

Field Summary

protected short	numberOfRecordSets number of record sets to transfer
protected EntityID	orginatingEntityID ID of entity originating request
protected EntityID	recevingEntityID ID of entity receiving request
protected java.util.List<RecordSet>	recordSets ^^^This is wrong--the RecordSet class needs more work
protected long	requestID ID ofrequest
protected short	requiredReliabilityService required level of reliabliity service.
protected short	tranferType type of transfer desired
protected EntityID	transferEntityID The entity for which control is being requested to transfer

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

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

Constructor Summary

TransferControlRequestPdu()
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	getMarshalledSize()
short	getNumberOfRecordSets()
EntityID	getOrginatingEntityID()
EntityID	getRecevingEntityID()
java.util.List<RecordSet>	getRecordSets()
long	getRequestID()
short	getRequiredReliabilityService()
short	getTranferType()
EntityID	getTransferEntityID()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setNumberOfRecordSets(short pNumberOfRecordSets) Note that setting this value will not change the marshalled value.
void	setOrginatingEntityID(EntityID pOrginatingEntityID)
void	setRecevingEntityID(EntityID pRecevingEntityID)
void	setRecordSets(java.util.List<RecordSet> pRecordSets)
void	setRequestID(long pRequestID)
void	setRequiredReliabilityService(short pRequiredReliabilityService)
void	setTranferType(short pTranferType)
void	setTransferEntityID(EntityID pTransferEntityID)
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.dismobile.Pdu

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

Methods inherited from class java.lang.Object

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

Field Detail

orginatingEntityID

protected EntityID orginatingEntityID

ID of entity originating request

recevingEntityID

protected EntityID recevingEntityID

ID of entity receiving request

requestID

protected long requestID

ID ofrequest

requiredReliabilityService

protected short requiredReliabilityService

required level of reliabliity service.

tranferType

protected short tranferType

type of transfer desired

transferEntityID

protected EntityID transferEntityID

The entity for which control is being requested to transfer

numberOfRecordSets

protected short numberOfRecordSets

number of record sets to transfer

recordSets

protected java.util.List<RecordSet> recordSets

^^^This is wrong--the RecordSet class needs more work

Constructor Detail

TransferControlRequestPdu

public TransferControlRequestPdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class EntityManagementFamilyPdu

setOrginatingEntityID

public void setOrginatingEntityID(EntityID pOrginatingEntityID)

getOrginatingEntityID

public EntityID getOrginatingEntityID()

setRecevingEntityID

public void setRecevingEntityID(EntityID pRecevingEntityID)

getRecevingEntityID

public EntityID getRecevingEntityID()

setRequestID

public void setRequestID(long pRequestID)

getRequestID

public long getRequestID()

setRequiredReliabilityService

public void setRequiredReliabilityService(short pRequiredReliabilityService)

getRequiredReliabilityService

public short getRequiredReliabilityService()

setTranferType

public void setTranferType(short pTranferType)

getTranferType

public short getTranferType()

setTransferEntityID

public void setTransferEntityID(EntityID pTransferEntityID)

getTransferEntityID

public EntityID getTransferEntityID()

getNumberOfRecordSets

public short getNumberOfRecordSets()

setNumberOfRecordSets

public void setNumberOfRecordSets(short pNumberOfRecordSets)

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

setRecordSets

public void setRecordSets(java.util.List<RecordSet> pRecordSets)

getRecordSets

public java.util.List<RecordSet> getRecordSets()

marshal

public void marshal(java.io.DataOutputStream dos)

Overrides:

marshal in class EntityManagementFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)

Overrides:

unmarshal in class EntityManagementFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

Overrides:

marshal in class EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.