Contents | Package | Class | Tree | Deprecated | Index | Help
PREV | NEXT SHOW LISTS | HIDE LISTS

Class mil.navy.nps.dis.EventReportPdu

java.lang.Object
    |
    +----mil.navy.nps.dis.PduElement
            |
            +----mil.navy.nps.dis.ProtocolDataUnit
                    |
                    +----mil.navy.nps.dis.SimulationManagementPdu
                            |
                            +----mil.navy.nps.dis.EventReportPdu

public class EventReportPdu
extends SimulationManagementPdu
Version:
1.0
Author:
Antonio Alexandre Rua (http://www.garfield.fe.up.pt/~alexrua)
Location:
http://www.stl.nps.navy.mil/dis-java-vrml/mil/navy/nps/dis/EventReportPdu.java
Hierarchy Diagram:
Summary:
A managed entity shall report the occurrence of a significat event to the simulation manager using an Event Report PDU.
History:
16Sep97 /Antonio Alexandre Rua /New
8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation
11Dec97 /Ronan Fauglas /changed access methods: thisVariable() --> getThisVariable()
14jan98 /Ronan Fauglas /changed datumspecification to datumInformation
References:
DIS Data Dictionary : Event Report PDU
DIS-Java-VRML Working Group: http://www.stl.nps.navy.mil/dis-java-vrml/
DIS specification : IEEE 1278.1, Section 5.4.6.11, 4.4.5.4
See Also:
ProtocolDataUnit, PduElement, mil.navy.nps.util.SerializationInterface, CreateEntityPdu, RemoveEntityPdu, StartResumePdu, StopFreezePdu, AcknowledgePdu, ActionRequestPdu, ActionResponsePdu, DataQueryPdu, SetDataPdu, DataPdu, EventReportPdu, CommentPdu

Field Summary
DatumSpecification  datumInformation
Datum Information - This field shall specify the types of datum and their value be communicated.
mil.navy.nps.util.UnsignedInt  eventType
Event Type - This field shall specify the type of event that caused the issue of an Event PDU.
static EventReportPdu  exemplar
An "exemplar" object, which is filled out to the state that is needed most of the time.
static int  sizeOf
Constant value--size of a Event Report PDU without header nor Datum Specification Record.
 
Fields inherited from class mil.navy.nps.dis.SimulationManagementPdu
 originatingEntityID, receivingEntityID, sizeOf
 
Fields inherited from class mil.navy.nps.dis.ProtocolDataUnit
 DEBUG, exerciseID, pduType, protocolFamily, protocolVersion, sizeOf, timestamp
 

Constructor Summary
 EventReportPdu()
Default constructor--fills with zeros for all values.
 

Method Summary
java.lang.Object  clone()
 
void  deSerialize(java.io.DataInputStream inputStream)
 
DatumSpecification  getDatumInformation()
 
mil.navy.nps.util.UnsignedInt  getEventType()
 
EventReportPdu  getExemplar()
 
int  length()
 
java.lang.String  PDUName()
 
void  printValues(int indentLevel, java.io.PrintStream printStream)
 
void  serialize(java.io.DataOutputStream outputStream)
 
void  setDatumInformation(DatumSpecification pDatumSpecification)
 
void  setEventType(long pEventType)
 
void  setExemplar(EventReportPdu newExemplar)
 
 
Methods inherited from class mil.navy.nps.dis.SimulationManagementPdu
 clone, deSerialize, getOriginatingEntityID, getReceivingEntityID, length, PDUName, printValues, serialize, setOriginatingEntityID, setReceivingEntityID
 
Methods inherited from class mil.navy.nps.dis.ProtocolDataUnit
 , clone, datagramToPdu, deSerialize, getExerciseID, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getVRMLTimestamp, length, makeTimestampCurrent, PDUName, printValues, serialize, setExerciseID, setExerciseID, setPduType, setPduType, setProtocolFamily, setProtocolFamily, setProtocolVersion, setProtocolVersion, setSimulationStartTime, setTimestamp, setTimestamp
 
Methods inherited from class mil.navy.nps.dis.PduElement
 clone, deSerialize, length, printValues, serialize
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

eventType

protected mil.navy.nps.util.UnsignedInt eventType
Event Type - This field shall specify the type of event that caused the issue of an Event PDU.
Value:
Enumeration. See references below for further information.
References:
see Section 7 in EBV-DOC
DIS Data Dictionary: Event Type Field

datumInformation

protected DatumSpecification datumInformation
Datum Information - This field shall specify the types of datum and their value be communicated.

sizeOf

public static final int sizeOf
Constant value--size of a Event Report PDU without header nor Datum Specification Record. sizeOf = 8 bytes

exemplar

protected static EventReportPdu exemplar
An "exemplar" object, which is filled out to the state that is needed most of the time.
Explanation
A brand new object has to have most of its values set, such as the forceID, protocol version, and so on. This lets the user fill out most of the values, save it in the class, then retrieve a copy of it as needed.
Constructor Detail

EventReportPdu

public EventReportPdu()
Default constructor--fills with zeros for all values.
Method Detail

PDUName

public java.lang.String PDUName()
Overrides:
PDUName in class SimulationManagementPdu

serialize

public void serialize(java.io.DataOutputStream outputStream)
Throws:
java.lang.RuntimeException - when IO Error occurs.
Overrides:
serialize in class SimulationManagementPdu

deSerialize

public void deSerialize(java.io.DataInputStream inputStream)
Throws:
java.lang.RuntimeException - when IO Error occurs.
Overrides:
deSerialize in class SimulationManagementPdu

clone

public java.lang.Object clone()
Overrides:
clone in class SimulationManagementPdu

length

public int length()
Overrides:
length in class SimulationManagementPdu

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)
Overrides:
printValues in class SimulationManagementPdu

getExemplar

public EventReportPdu getExemplar()

setExemplar

public void setExemplar(EventReportPdu newExemplar)

getEventType

public mil.navy.nps.util.UnsignedInt getEventType()

setEventType

public void setEventType(long pEventType)

getDatumInformation

public DatumSpecification getDatumInformation()

setDatumInformation

public void setDatumInformation(DatumSpecification pDatumSpecification)

Contents | Package | Class | Tree | Deprecated | Index | Help
PREV | NEXT SHOW LISTS | HIDE LISTS