Skip to content

EntityType

Jump to bottom
huggins edited this page Apr 10, 2025 · 7 revisions

Entity Type

Container for Entity Type information. Specifies the type of an entity in a DIS exercise.

struct FEntityType

Back to Top

Members

Type Name Description
uint8 Category This field shall specify the main category that describes the entity. The enumerations of category depend upon both the Kind and Domain.
int32 Country This field shall specify the country to which the design of the entity is attributed. This field shall be represented by a 16-bit enumeration.
uint8 Domain This field shall specify the domain in which the equipment operates except for munition entities. For Munition entities this field shall specify the domain of the target.
uint8 EntityKind This field shall identify the Kind of Entity.
uint8 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.
uint8 Specific This field shall specify specific information about an entity based upon the subcategory field to which it belongs.
uint8 Subcategory This field shall specify a particular subcategory to which the entity belongs based on the category and the country.
bool UseSpecific_Category If the category should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_Country If the country should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_Domain If the domain should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_EntityKind If the entity kind should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_Extra If the extra should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_Specific If the specific should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.
bool UseSpecific_Subcategory If the subcategory should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Back to Top

Constructors

Name Description
FEntityType() Default constructor
FEntityType(DIS::EntityType EntityType) Constructor that takes in the OpenDIS EntityType struct.
FEntityType(double EntityType) Constructor that converts a given double into an FEntityType.

Functions

Return Name Description
bool EntityTypeFieldEqualTo(int32 lhs, int32 rhs, bool lhsUseSpecific, bool rhsUseSpecific) Utilized for determining if an entity type field is equivalent to another. Takes wildcards into account.
bool EntityTypeFieldGreaterThan(int32 lhs, int32 rhs, bool lhsUseSpecific, bool rhsUseSpecific) Utilized for determining if an entity type field is greater than another. Takes wildcards into account.
bool EntityTypeFieldLessThan(int32 lhs, int32 rhs, bool lhsUseSpecific, bool rhsUseSpecific) Utilized for determining if an entity type field is less than another. Takes wildcards into account.
FEntityType FillWildcards(const FEntityType Other) Utilized for wildcard Entity Types. Replaces wildcard placeholders with actual values.
uint64 GetTypeHash(const FEntityType& other) Converts an Entity Type to be usable as a hash.
bool HasWildcards() Utilized for determining if an entity type has any wildcard values in it.
FString ToBitString() Conversion of an Entity Type to a bit string
double ToDouble() Conversion of an Entity Type to a double.
DIS::EntityType ToOpenDIS() Conversion to OpenDIS EntityType struct
FString ToString() Conversion of an Entity Type to an FString.
uint64 ToUInt64() Conversion of an Entity Type to a uint64.

Operator Overloads

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

Back to Top

Details

Category

uint8 Category

This field shall specify the main category that describes the entity. The enumerations of category depend upon both the Kind and Domain.

Category: GRILL DIS|Structs

Back to Top

Country

int32 Country

This field shall specify the country to which the design of the entity is attributed. This field shall be represented by a 16-bit enumeration.

Category: GRILL DIS|Structs

Range: [0, 65535]

Back to Top

Domain

uint8 Domain

This field shall specify the domain in which the equipment operates except for munition entities. For Munition entities this field shall specify the domain of the target.

Category: GRILL DIS|Structs

Back to Top

Entity Kind

uint8 EntityKind

This field shall identify the Kind of Entity.

Category: GRILL DIS|Structs

Back to Top

Extra

uint8 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.

Category: GRILL DIS|Structs

Back to Top

Specific

uint8 Specific

This field shall specify specific information about an entity based upon the subcategory field to which it belongs.

Category: GRILL DIS|Structs

Back to Top

Subcategory

uint8 Subcategory

This field shall specify a particular subcategory to which the entity belongs based on the category and the country.

Category: GRILL DIS|Structs

Back to Top

UseSpecific_Category

bool UseSpecific_Category

If the category should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_Country

bool UseSpecific_Country

If the country should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_Domain

bool UseSpecific_Domain

If the domain should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_EntityKind

bool UseSpecific_EntityKind

If the entity kind should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_Extra

bool UseSpecific_Extra

If the extra should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_Specific

bool UseSpecific_Specific

If the specific should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

UseSpecific_Subcategory

bool UseSpecific_Subcategory

If the subcategory should be represented by a specific value or a wildcard. If field is true, a specific value is used. If field is false, a wildcard will be used.

Category: Wildcards

Back to Top

FEntityType

FEntityType()

Default constructor

Back to Top

FEntityType

FEntityType
(
	DIS::EntityType EntityType
)

Constructor that takes in the OpenDIS EntityType struct.

Parameter Description
EntityType The OpenDIS EntityType struct to convert to an FEntityType struct.

Back to Top

FEntityType

FEntityType
(
	double EntityType
)

Constructor that converts a given double into an FEntityType.

Parameter Description
EntityType The double to convert to an FEntityType struct.

Back to Top

EntityTypeFieldEqualTo

bool EntityTypeFieldEqualTo
(
	int32 lhs,
	int32 rhs,
	bool lhsUseSpecific,
	bool rhsUseSpecific
) const

Utilized for determining if an entity type field is equivalent to another. Takes wildcards into account.

Parameter Description
lhs The entity type field to act as the left hand side in the comparison.
rhs The entity type field to act as the right hand side in the comparison.
lhsUseSpecific Whether the left hand side field is acting as a specific value or a wildcard.
rhsUseSpecific Whether the right hand side field is acting as a specific value or a wildcard.
Returns
A boolean specifying whether or not the lhs is equal to the rhs.

Back to Top

EntityTypeFieldGreaterThan

bool EntityTypeFieldGreaterThan
(
	int32 lhs,
	int32 rhs,
	bool lhsUseSpecific,
	bool rhsUseSpecific
) const

Utilized for determining if an entity type field is greater than another. Takes wildcards into account.

Parameter Description
lhs The entity type field to act as the left hand side in the comparison.
rhs The entity type field to act as the right hand side in the comparison.
lhsUseSpecific Whether the left hand side field is acting as a specific value or a wildcard.
rhsUseSpecific Whether the right hand side field is acting as a specific value or a wildcard.
Returns
A boolean specifying whether or not the lhs is greater than the rhs.

Back to Top

EntityTypeFieldLessThan

bool EntityTypeFieldLessThan
(
	int32 lhs,
	int32 rhs,
	bool lhsUseSpecific,
	bool rhsUseSpecific
) const

Utilized for determining if an entity type field is less than another. Takes wildcards into account.

Parameter Description
lhs The entity type field to act as the left hand side in the comparison.
rhs The entity type field to act as the right hand side in the comparison.
lhsUseSpecific Whether the left hand side field is acting as a specific value or a wildcard.
rhsUseSpecific Whether the right hand side field is acting as a specific value or a wildcard.
Returns
A boolean specifying whether or not the lhs is less than the rhs.

Back to Top

FillWildcards

FEntityType FillWildcards
(
	const FEntityType Other
)

Utilized for wildcard Entity Types. Replaces wildcard placeholders with actual values.

Parameter Description
Other The FEntityType to replace the wildcard placeholders of.
Returns
An FEntityType without and wildcard placeholders.

Back to Top

GetTypeHash

friend uint32 GetTypeHash
(
	const FEntityType& other
)

Converts an Entity Type to be usable as a hash

Parameter Description
other The Entity Type to get the hash of.
Returns
The uint32 hash of the given FEntityType.

Back to Top

HasWildcards

bool HasWildcards() const

Utilized for determining if an entity type has any wildcard values in it.

Returns
A boolean specifying whether or not the entity type has any wildcards values in it.

Back to Top

ToBitString

FString ToBitString() const

Conversion of an Entity Type to a bit string.

Returns
The bit string representation of this FEntityType as an FString.

Back to Top

ToDouble

double ToDouble() const

Conversion of an Entity Type to a double.

Returns
The double representation of this FEntityType.

Back to Top

ToOpenDIS

DIS::FEntityType ToOpenDIS() const

Conversion to OpenDIS EntityType struct.

Returns
The OpenDIS EntityType struct representation of this FEntityType.

Back to Top

ToString

FString ToString()

Conversion of an Entity Type to an FString.

Returns
The string representation of this FEntityType.

Back to Top

ToUInt64

uint64 ToUInt64() const

Conversion of an Entity Type to a uint64.

Returns
The uint64 representation of this FEntityType.

Back to Top

operator==

bool operator== 
(
	const FEntityType other
) const

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

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

Back to Top

operator!=

bool operator!= 
(
	const FEntityType other
) const

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

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

Back to Top

operator<

bool operator< 
(
	const FEntityType other
) const

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

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

Back to Top

operator>

bool operator> 
(
	const FEntityType other
) const

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

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

Back to Top

operator<=

bool operator<= 
(
	const FEntityType other
) const

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

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

Back to Top

operator>=

bool operator>= 
(
	const FEntityType other
) const

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

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

Back to Top

Clone this wiki locally