VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stopFreezePdu.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2025 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
8 
9 #pragma once
10 
11 #if DtDIS
12 
13 #include <vlpi/disEnums.h>
14 #include "hostStructs.h"
15 #include "simanPdu.h"
16 
20 
22 typedef void (*DtStopFreezePduCb)(DtStopFreezePdu *pdu, void *usr);
23 
28 {
29 public:
30 
31  enum { PduStaticSize=40 };
32 
33 public:
36  DtStopFreezePdu(const DtNetStopFreezePdu *initial,
37  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
38 
40  const DtEntityIdentifier &from,
41  const DtTime realTime,
42  DtStopReason reason,
44 
45 
46 
48  DtTime realWorldTime() const;
49  void setRealWorldTime(const DtTime time);
50 
53  DtTimeStampType realWorldTimeType() const;
54  void setRealWorldTimeType(const DtTimeStampType type);
55 
57  DtStopReason reason() const;
58  void setReason(DtStopReason reason);
59 
60 
62  int requestId() const;
63  void setRequestId(int id);
64 
66  int frozenBehavior() const;
67  void setFrozenBehavior(int behavior);
68 
72  virtual bool reflectWhenFrozen() const;
73  virtual void setReflectWhenFrozen(bool flag);
74 
78  virtual bool runClockWhenFrozen() const;
79  virtual void setRunClockWhenFrozen(bool flag);
80 
84  virtual bool updateWhenFrozen() const;
85  virtual void setUpdateWhenFrozen(bool flag);
86 
88  virtual void printData() const;
89 
91  virtual void printDataToStream(std::ostream& stream) const;
92 
93 public:
96  static DtPdu *create(const DtNetPacket *initial,
97  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
98 
101  static void addCallback(DtExerciseConn *conn,
102  DtStopFreezePduCb cb, void *usr);
103  static void removeCallback(DtExerciseConn *conn,
104  DtStopFreezePduCb cb, void *usr);
105 
106 protected:
109 
110 };
111 
112 #endif
void(* DtStopFreezePduCb)(DtStopFreezePdu *pdu, void *usr)
DtStopFreezePdu callback function signature.
Definition: stopFreezePdu.h:22
Instances of DtExerciseConn are used to provide an application&#39;s interface or connection to the netwo...
Definition: exerciseConnDIS.h:62
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
DtStopReason
Definition: disEnums.h:387
Definition: pduHeader.h:14
class DtPduFactory:
Definition: pduFactory.h:38
Definition: disEnums.h:254
DtPdu is the base class for all PDU&#39;s in VR-Link.
Definition: pdu.h:69
DtSimanPdu provides a base class for all of the simulation management PDU&#39;s.
Definition: simanPdu.h:23
Definition: simanP4.h:36
Instances of DtEntityIdentifier are used as a unique ID for entities in DIS.
Definition: entityIdentifier.h:31
virtual void printDataToStream(std::ostream &stream) const
Prints the contents of the PDU to the specified stream.
This file is deprecated - Please see simulationAddress.h, entityIdentifier.h, entityType.h, burstDescriptor.h, and NetStructs.h.
struct DtBufferPlaceHolder * DtBufferPtr
Definition: vlBaseMsg.h:17
virtual void printData() const
Prints the contents of the PDU.
#define DtUSE_INTERNAL_BUFFER
Definition: vlBaseMsg.h:22
Contains the standard DIS enumerations.
DtTimeStampType
Definition: vlTimeStampType.h:16
DtPduKind internalGetPduKind() const
Returns the internal PDU kind.
Definition: stopFreezePdu.h:108
DtPduKind
([UID 4]) - PDU Type
Definition: disEnums.h:238
DtStopFreezePdu DtStopFreezeInteraction
Definition: stopFreezePdu.h:18
Instances of DtStopFreezePdu are used to send/receive stop/freeze PDUs.
Definition: stopFreezePdu.h:27

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)