Class AggregateType

java.lang.Object

edu.nps.moves.dis7.pdus.AggregateType

All Implemented Interfaces:

Serializable

public class AggregateType
extends Object
implements Serializable

Identifies the type and organization of an aggregate. Section 6.2.5

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AggregateStateAggregateKind	aggregateKind	Grouping criterion used to group the aggregate.
protected byte	category	category of entity
protected Country	country	country to which the design of the entity is attributed uid 29
protected PlatformDomain	domain	Domain of entity (air, surface, subsurface, space, etc.) where zero means domain does not apply. uid 8
protected byte	extra	extra is an undescribed parameter...
protected AggregateStateSpecific	specificInfo	specific info based on subcategory field. specific is a reserved word in sql. uid 209
protected AggregateStateSubcategory	subcategory	subcategory of entity uid 208

Constructor Summary

Constructors

Constructor	Description
AggregateType()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
AggregateStateAggregateKind	getAggregateKind()	Getter for aggregateKind
byte	getCategory()	Getter for category
Country	getCountry()	Getter for country
PlatformDomain	getDomain()	Getter for domain
byte	getExtra()	Getter for extra
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
AggregateStateSpecific	getSpecificInfo()	Getter for specificInfo
AggregateStateSubcategory	getSubcategory()	Getter for subcategory
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
AggregateType	setAggregateKind(AggregateStateAggregateKind pAggregateKind)	Setter for aggregateKind
AggregateType	setCategory(byte pCategory)	Setter for category
AggregateType	setCategory(int pCategory)	Utility setter for category
AggregateType	setCountry(Country pCountry)	Setter for country
AggregateType	setDomain(PlatformDomain pDomain)	Setter for domain
AggregateType	setExtra(byte pExtra)	Setter for extra
AggregateType	setExtra(int pExtra)	Utility setter for extra
AggregateType	setSpecificInfo(AggregateStateSpecific pSpecificInfo)	Setter for specificInfo
AggregateType	setSubcategory(AggregateStateSubcategory pSubcategory)	Setter for subcategory
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

aggregateKind

protected AggregateStateAggregateKind aggregateKind

Grouping criterion used to group the aggregate. Enumeration from EBV document uid 206

domain

protected PlatformDomain domain

Domain of entity (air, surface, subsurface, space, etc.) where zero means domain does not apply. uid 8

country

protected Country country

country to which the design of the entity is attributed uid 29

category

protected byte category

category of entity

subcategory

protected AggregateStateSubcategory subcategory

subcategory of entity uid 208

specificInfo

protected AggregateStateSpecific specificInfo

specific info based on subcategory field. specific is a reserved word in sql. uid 209

extra

protected byte extra

extra is an undescribed parameter...

Constructor Details

AggregateType

public AggregateType()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setAggregateKind

public AggregateType setAggregateKind(AggregateStateAggregateKind pAggregateKind)

Setter for aggregateKind

Parameters:

pAggregateKind - new value of interest

Returns:

same object to permit progressive setters

getAggregateKind

public AggregateStateAggregateKind getAggregateKind()

Getter for aggregateKind

Returns:

value of interest

setDomain

public AggregateType setDomain(PlatformDomain pDomain)

Setter for domain

Parameters:

pDomain - new value of interest

Returns:

same object to permit progressive setters

getDomain

public PlatformDomain getDomain()

Getter for domain

Returns:

value of interest

setCountry

public AggregateType setCountry(Country pCountry)

Setter for country

Parameters:

pCountry - new value of interest

Returns:

same object to permit progressive setters

getCountry

public Country getCountry()

Getter for country

Returns:

value of interest

setCategory

public AggregateType setCategory(byte pCategory)

Setter for category

Parameters:

pCategory - new value of interest

Returns:

same object to permit progressive setters

setCategory

public AggregateType setCategory(int pCategory)

Utility setter for category

Parameters:

pCategory - new value of interest

Returns:

same object to permit progressive setters

getCategory

public byte getCategory()

Getter for category

Returns:

value of interest

setSubcategory

public AggregateType setSubcategory(AggregateStateSubcategory pSubcategory)

Setter for subcategory

Parameters:

pSubcategory - new value of interest

Returns:

same object to permit progressive setters

getSubcategory

public AggregateStateSubcategory getSubcategory()

Getter for subcategory

Returns:

value of interest

setSpecificInfo

public AggregateType setSpecificInfo(AggregateStateSpecific pSpecificInfo)

Setter for specificInfo

Parameters:

pSpecificInfo - new value of interest

Returns:

same object to permit progressive setters

getSpecificInfo

public AggregateStateSpecific getSpecificInfo()

Getter for specificInfo

Returns:

value of interest

setExtra

public AggregateType setExtra(byte pExtra)

Setter for extra

Parameters:

pExtra - new value of interest

Returns:

same object to permit progressive setters

setExtra

public AggregateType setExtra(int pExtra)

Utility setter for extra

Parameters:

pExtra - new value of interest

Returns:

same object to permit progressive setters

getExtra

public byte getExtra()

Getter for extra

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Parameters:

dos - the OutputStream

Throws:

Exception - if something goes wrong

See Also:

• DataOutputStream

unmarshal

public int unmarshal(DataInputStream dis)
              throws Exception

Deserializes an object from a DataInputStream.

Parameters:

dis - the InputStream

Returns:

marshalled serialized size in bytes

Throws:

Exception - if something goes wrong

See Also:

• DataInputStream
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Packs an object into the ByteBuffer.

Parameters:

byteBuffer - The ByteBuffer at the position to begin writing

Throws:

BufferOverflowException - if byteBuffer is too small

ReadOnlyBufferException - if byteBuffer is read only

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer

unmarshal

public int unmarshal(ByteBuffer byteBuffer)
              throws Exception

Unpacks a Pdu from the underlying data.

Parameters:

byteBuffer - The ByteBuffer at the position to begin reading

Returns:

marshalled serialized size in bytes

Throws:

BufferUnderflowException - if byteBuffer is too small

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsImpl

public boolean equalsImpl(Object obj)

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

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object