Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Class mil.navy.nps.dis.EntityType

java.lang.Object
  |
  +--mil.navy.nps.dis.PduElement
        |
        +--mil.navy.nps.dis.EntityType

public class EntityType
extends PduElement
Version:
1.0
Author:
Don McGregor (http://www.stl.nps.navy.mil/~mcgredo)
Location:
http://www.stl.nps.navy.mil/dis-java-vrml/mil/navy/nps/dis/EntityType.java
Hierarchy Diagram:
Summary:
This record shall specify the kind of entity, the country of design, the domain, the specific identification of the entity, and any extra information necessary for describing the entity.

Explanation:
The type of entity in a DIS exercise shall be specified by an Entity Type record. Fields not used shall contain the value zero.

History:
2Dec96 /Don McGregor /New
10Mar97 /Don McGregor /Cleaned up for javadoc
16Apr97 /Don McGregor /PrintStream passed to printValues
8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation
8Dec97 /Ronan Fauglas /changed entityKind to kind
References:
DIS Data Dictionary : Entity Type Record

DIS specification : IEEE 1278.1, 5.3.16
See Also:
PduElement

Field Summary
mil.navy.nps.util.UnsignedByte category
          This field shall specify the main category that describes the entity.
mil.navy.nps.util.UnsignedShort country
          This field shall specify the country to which the design of the entity is attributed. a 16 bits enumeration.
mil.navy.nps.util.UnsignedByte domain
          This field shall specify the domain in which the equipment operates (for example, subsurface, surface, land, etc.) except for munition entities.
mil.navy.nps.util.UnsignedByte extra
          This field shall specify extra information required to describe a particular entity.
mil.navy.nps.util.UnsignedByte kind
          Entity kind: munition, life form, environmental...
static int sizeOf
          Constant value--size of an EntityType as written out to the wire.
mil.navy.nps.util.UnsignedByte specific
          This field shall specify specific information about an entity based upon the subcategory field to which it belongs.
mil.navy.nps.util.UnsignedByte subCategory
          This field shall specify a particular subcategory to which the entity belongs based on the category and the country.
 
Constructor Summary
EntityType()
          Default constructor--fills with zeros for all values.
 
Method Summary
java.lang.Object clone()
           
void deSerialize(java.io.DataInputStream inputStream)
           
mil.navy.nps.util.UnsignedByte getCategory()
           
mil.navy.nps.util.UnsignedShort getCountry()
           
mil.navy.nps.util.UnsignedByte getDomain()
           
mil.navy.nps.util.UnsignedByte getExtra()
           
mil.navy.nps.util.UnsignedByte getKind()
           
mil.navy.nps.util.UnsignedByte getSpecific()
           
mil.navy.nps.util.UnsignedByte getSubCategory()
           
int length()
           
void printValues(int indentLevel, java.io.PrintStream printStream)
           
void serialize(java.io.DataOutputStream outputStream)
           
void setCategory(mil.navy.nps.util.UnsignedByte pCategory)
           
void setCategory(int pCategory)
           
void setCountry(mil.navy.nps.util.UnsignedShort pCountry)
           
void setCountry(int pCountry)
           
void setDomain(mil.navy.nps.util.UnsignedByte pDomain)
           
void setDomain(int pDomain)
           
void setExtra(mil.navy.nps.util.UnsignedByte pExtra)
           
void setExtra(int pExtra)
           
void setKind(mil.navy.nps.util.UnsignedByte pKind)
           
void setKind(int pKind)
           
void setSpecific(mil.navy.nps.util.UnsignedByte pSpecific)
           
void setSpecific(int pSpecific)
           
void setSubCategory(mil.navy.nps.util.UnsignedByte pSubCategory)
           
void setSubCategory(int pSubCategory)
           
 
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, notifyAll, notify, toString, wait, wait, wait
 

Field Detail

kind

protected mil.navy.nps.util.UnsignedByte kind
Entity kind: munition, life form, environmental... For now, entity kind is : 0-9
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Entity Kind Field
see Section 4 in EBV-DOC

domain

protected mil.navy.nps.util.UnsignedByte domain
This field shall specify the domain in which the equipment operates (for example, subsurface, surface, land, etc.) except for munition entities. For Munition entities this field shall specify the domain of the target (for example the munition might be surface-to-air, so the domain would be anti-air).
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Entity Domain Field
see Section 4 in EBV-DOC

country

protected mil.navy.nps.util.UnsignedShort country
This field shall specify the country to which the design of the entity is attributed. a 16 bits enumeration.
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Country Field
See Section 4 in EBV-DOC

category

protected mil.navy.nps.util.UnsignedByte category
This field shall specify the main category that describes the entity. The enumerations of category depend upon both the Kind and Domain.
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Entity Category Field
See Section 4 in EBV-DOC

subCategory

protected mil.navy.nps.util.UnsignedByte subCategory
This field shall specify a particular subcategory to which the entity belongs based on the category and the country.
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Entity Subcategory Field
See Section 4 in EBV-DOC

specific

protected mil.navy.nps.util.UnsignedByte specific
This field shall specify specific information about an entity based upon the subcategory field to which it belongs.
Value: Enumeration; see references below for information.
References:
DIS Data Dictionary: Entity Specific Field
See Section 4 in EBV-DOC

extra

protected mil.navy.nps.util.UnsignedByte extra
This field shall specify extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented.
Value: Enumeration.
References:
DIS Data Dictionary: Entity Extra Field

sizeOf

public static final int sizeOf
Constant value--size of an EntityType as written out to the wire. Here: sizeOf = 8 bytes
Constructor Detail

EntityType

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

clone

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

serialize

public void serialize(java.io.DataOutputStream outputStream)
Overrides:
serialize in class PduElement

deSerialize

public void deSerialize(java.io.DataInputStream inputStream)
Overrides:
deSerialize in class PduElement

length

public int length()
Overrides:
length in class PduElement

printValues

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

getKind

public mil.navy.nps.util.UnsignedByte getKind()

setKind

public void setKind(mil.navy.nps.util.UnsignedByte pKind)

setKind

public void setKind(int pKind)

getDomain

public mil.navy.nps.util.UnsignedByte getDomain()

setDomain

public void setDomain(mil.navy.nps.util.UnsignedByte pDomain)

setDomain

public void setDomain(int pDomain)

getCountry

public mil.navy.nps.util.UnsignedShort getCountry()

setCountry

public void setCountry(mil.navy.nps.util.UnsignedShort pCountry)

setCountry

public void setCountry(int pCountry)

getCategory

public mil.navy.nps.util.UnsignedByte getCategory()

setCategory

public void setCategory(mil.navy.nps.util.UnsignedByte pCategory)

setCategory

public void setCategory(int pCategory)

getSubCategory

public mil.navy.nps.util.UnsignedByte getSubCategory()

setSubCategory

public void setSubCategory(mil.navy.nps.util.UnsignedByte pSubCategory)

setSubCategory

public void setSubCategory(int pSubCategory)

getSpecific

public mil.navy.nps.util.UnsignedByte getSpecific()

setSpecific

public void setSpecific(mil.navy.nps.util.UnsignedByte pSpecific)

setSpecific

public void setSpecific(int pSpecific)

getExtra

public mil.navy.nps.util.UnsignedByte getExtra()

setExtra

public void setExtra(mil.navy.nps.util.UnsignedByte pExtra)

setExtra

public void setExtra(int pExtra)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD