Skip to content

EntityID

Jump to bottom
huggins edited this page May 3, 2023 · 6 revisions

Entity ID

Container for Entity ID information. Each Entity in a DIS exercise shall be assigned an Entity ID unique to the exercise.

struct FEntityID

Back to Top

Members

Type Name Description
int32 Application The Application ID.
int32 Entity The Entity ID.
int32 Site The Site ID.

Back to Top

Constructors

Name Description
FEntityID() Default constructor
FEntityID(DIS::EntityID EntityID) Constructor that takes in the OpenDIS EntityID struct

Functions

Return Name Description
uint64 GetTypeHash(const FEntityID& other) Converts an Entity ID to be usable as a hash.
DIS::EntityID ToOpenDIS() Conversion to OpenDIS EntityID struct
FString ToString() Conversion of an Entity ID to an FString.
uint64 ToUInt64() Conversion of an Entity ID to a uint64.

Operator Overloads

Return Name Description
bool operator==(const FEntityID Other) Overloads the == operator. Compares two Entity IDs to see if they are equal.
bool operator!=(const FEntityID Other) Overloads the != operator. Compares two Entity IDs to see if they are not equal.
bool operator<(const FEntityID Other) Overloads the < operator. Compares two Entity IDs to see if this Entity ID is less than the passed Entity ID.
bool operator>(const FEntityID Other) Overloads the > operator. Compares two Entity IDs to see if this Entity ID is greater than the passed Entity ID.
bool operator<=(const FEntityID Other) Overloads the <= operator. Compares two Entity IDs to see if this Entity ID is less than or equal to the passed Entity ID.
bool operator>=(const FEntityID Other) Overloads the >= operator. Compares two Entity IDs to see if this Entity ID is greater than or equal to the passed Entity ID.

Back to Top

Details

Application

int32 Application

The Application ID.

Category: GRILL DIS|Structs

Range: [0, 65535]

Back to Top

Entity

int32 Entity

The Entity ID.

Category: GRILL DIS|Structs

Range: [0, 65535]

Back to Top

Site

int32 Site

The Site ID.

Category: GRILL DIS|Structs

Range: [0, 65535]

Back to Top

FEntityID

FEntityID()

Default constructor

Back to Top

FEntityID

FEntityID
(
	DIS::EntityID EntityID
)

Constructor that takes in the OpenDIS EntityID struct

Parameter Description
EntityID The OpenDIS EntityID struct to convert to an FEntityID struct.

Back to Top

GetTypeHash

friend uint32 GetTypeHash
(
	const FEntityID& other
)

Converts an Entity ID to be usable as a hash

Parameter Description
other The Entity ID to get the hash of.
Returns
The uint32 hash of the given FEntityID.

Back to Top

ToOpenDIS

DIS::EntityID ToOpenDIS() const

Conversion to OpenDIS EntityID struct.

Returns
The OpenDIS EntityID struct representation of this FEntityID.

Back to Top

ToString

FString ToString()

Conversion of an Entity ID to an FString.

Returns
The string representation of this FEntityID.

Back to Top

ToUInt64

uint64 ToUInt64() const

Conversion of an Entity ID to a uint64.

Returns
The uint64 representation of this FEntityID.

Back to Top

operator==

bool operator== 
(
	const FEntityID other
) const

Overloads the == operator. Compares two Entity IDs to see if they are equal.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not the two FEntityID structs are equivalent.

Back to Top

operator!=

bool operator!= 
(
	const FEntityID other
) const

Overloads the != operator. Compares two Entity IDs to see if they are not equal.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not the two FEntityID structs are not equivalent.

Back to Top

operator<

bool operator< 
(
	const FEntityID other
) const

Overloads the < operator. Compares two Entity IDs to see if this Entity ID is less than the passed Entity ID.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not this FEntityID struct is less than the passed FEntityID.

Back to Top

operator>

bool operator> 
(
	const FEntityID other
) const

Overloads the > operator. Compares two Entity IDs to see if this Entity ID is greater than the passed Entity ID.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not this FEntityID struct is greater than the passed FEntityID.

Back to Top

operator<=

bool operator<= 
(
	const FEntityID other
) const

Overloads the <= operator. Compares two Entity IDs to see if this Entity ID is less than or equal to the passed Entity ID.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not this FEntityID struct is less than or equal to the passed FEntityID.

Back to Top

operator>=

bool operator>= 
(
	const FEntityID other
) const

Overloads the >= operator. Compares two Entity IDs to see if this Entity ID is greater than or equal to the passed Entity ID.

Parameter Description
other The FEntityID struct to compare this FEntityID struct to.
Returns
Whether or not this FEntityID struct is greater than or equal to the passed FEntityID.

Back to Top

Clone this wiki locally