-
Notifications
You must be signed in to change notification settings - Fork 16
EntityType
Container for Entity Type information. Specifies the type of an entity in a DIS exercise.
struct FEntityType
Type | Name | Description |
---|---|---|
int32 | 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. |
int32 | 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. |
int32 | EntityKind | This field shall identify the Kind of Entity. |
int32 | 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. |
int32 | Specific | This field shall specify specific information about an entity based upon the subcategory field to which it belongs. |
int32 | Subcategory | This field shall specify a particular subcategory to which the entity belongs based on the category and the country. |
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. |
Return | Name | Description |
---|---|---|
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. |
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. |
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. |
int32 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
Range: [0, 255]
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]
int32 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
Range: [0, 255]
int32 EntityKind
This field shall identify the Kind of Entity.
Category: GRILL DIS|Structs
Range: [0, 255]
int32 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
Range: [0, 255]
int32 Specific
This field shall specify specific information about an entity based upon the subcategory field to which it belongs.
Category: GRILL DIS|Structs
Range: [0, 255]
int32 Subcategory
This field shall specify a particular subcategory to which the entity belongs based on the category and the country.
Category: GRILL DIS|Structs
Range: [0, 255]
FEntityType()
Default constructor
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. |
FEntityType
(
double EntityType
)
Constructor that converts a given double into an FEntityType.
Parameter | Description |
---|---|
EntityType | The double to convert to an FEntityType struct. |
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. |
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. |
FString ToBitString() const
Conversion of an Entity Type to a bit string.
Returns |
---|
The bit string representation of this FEntityType as an FString. |
double ToDouble() const
Conversion of an Entity Type to a double.
Returns |
---|
The double representation of this FEntityType. |
DIS::FEntityType ToOpenDIS() const
Conversion to OpenDIS EntityType struct.
Returns |
---|
The OpenDIS EntityType struct representation of this FEntityType. |
FString ToString()
Conversion of an Entity Type to an FString.
Returns |
---|
The string representation of this FEntityType. |
uint64 ToUInt64() const
Conversion of an Entity Type to a uint64.
Returns |
---|
The uint64 representation of this FEntityType. |
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. |
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. |
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. |
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. |
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. |
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. |