Skip to content

StopFreezePDU

huggins edited this page May 3, 2023 · 5 revisions

Stop Freeze PDU

Struct container for all information that is contained inside of DIS Stop Freeze PDUs.

struct FStopFreezePDU
	: public FSimulationManagementFamilyPDU

Includes

Back to Top


Members

Type Name Description
int32 FrozenBehavior Specification of the internal behavior of the simulation and its appearance while frozen to other participants of the exercise
int32 PaddingOne Unused padding
FClockTime RealWorldTime The real-world time at which the entity/exercise is to stop/freeze in the exercise.
EReason Reason The reason that an entity or exercise was stopped/frozen.
int64 RequestID The specific and unique stop/freeze request being made by the simulation.

Back to Top


Constructors

Name Description
FStopFreezePDU() Default constructor

Destructors

Name Description
~FStopFreezePDU() Default destructor

Functions

Return Name Description
SetupFromOpenDIS(DIS::StopFreezePdu* StopFreezePDUIn) Converts an OpenDIS StopFreezePdu struct to an FStopFreezePDU struct.
TArray<uint8> ToBytes() Conversion to an array of bytes. Allows for an FStopFreezePDU struct to be sent out with a UDP send socket.
ToOpenDIS(DIS::StopFreezePdu& StopFreezePDUOut) Conversion to OpenDIS StopFreezePdu struct

Back to Top


Details

FrozenBehavior

int32 FrozenBehavior

Specification of the internal behavior of the simulation and its appearance while frozen to other participants of the exercise

Category: GRILL DIS|Structs|PDUs|StopFreeze

Back to Top


PaddingOne

int32 PaddingOne

Unused padding

Back to Top


RealWorldTime

FClockTime RealWorldTime

The real-world time at which the entity/exercise is to start/resume in the exercise.

Category: GRILL DIS|Structs|PDUs|StopFreeze

Back to Top


Reason

EReason Reason

The reason that an entity or exercise was stopped/frozen.

Category: GRILL DIS|Structs|PDUs|StopFreeze

Back to Top


RequestID

int64 RequestID

The specific and unique start/resume request being made by the simulation.

Category: GRILL DIS|Structs|PDUs|StopFreeze

Back to Top


FStopFreezePDU

FStopFreezePDU() : FSimulationManagementFamilyPDU()

Default constructor.

Back to Top


~FStopFreezePDU

virtual ~FStopFreezePDU()

Default destructor.

Back to Top


SetupFromOpenDIS

void SetupFromOpenDIS
(
	DIS::StopFreezePdu* StopFreezePDUIn
)

Converts an OpenDIS StopFreezePdu struct to an FStopFreezePDU struct.

Parameter Description
StopFreezePDUIn The OpenDIS StopFreezePdu struct to convert.

Back to Top


ToBytes

void ToOpenDIS
(
	DIS::StopFreezePdu& StopFreezePDUOut
)

Conversion to an array of bytes. Allows for an FStopFreezePDU struct to be sent out with a UDP send socket.

Parameter Description
StopFreezePDUOut The OpenDIS StopFreezePdu struct representation of this FStopFreezePDU.

Back to Top


ToOpenDIS

virtual TArray<uint8> ToBytes() override

Conversion to OpenDIS StopFreezePdu struct

Returns
An array of bytes containing the information from this FStopFreezePDU.

Back to Top


Clone this wiki locally