vsTASKER 7 User Manual
×
Menu
Index
Search
 
   
   
   
 
Copyright VirtualSim 2004-2020 - All rights reserved

Packet Properties

 
Packet Properties
1

Name

1. Name
Name of the Packet. Must be unique.
 
2

Mode

2. Mode
Each Packet can either send or receive. If the mode is changed, the section on the diagram the Packet belongs will also change.
 
3

Belongs

3. Belongs
If the Packet must use a particular entity data, select it here if it already exist in the scenario.
The variable entity will be set at runtime.
Otherwise, the following code in the Initialization panel (RESET phase) will do the trick: entity = S:findEntity("myEntity");
 
4

Import / Export

4. Import / Export
Use Import to replace the current Packet with a previously exported one.
Use Export to save the current Packet to a file for later retrieval or sharing.
Default location is /Data/Shared. Extension is .pkt
 
5

Cycling

5. Cycling
Chose the frequency at which the runtime code of the SockItem will be called. If On_Event, call happens only when the proper event is received (10).
If Fixed Hz is checked, the frequency will the the wall clock one and not the simulation clock.
(Only for Senders).
 
6

Receiving Mode

6. Receiving Mode
Put here the message stamp sent by the IG and that triggers the runtime code of this Packet.
i.e: CIGI_POSITION_RESP_PACKET_ID_V3
(Only for Receivers)
 
7

Data Model

7. Data Model
If a specific Data Model must be used jointly with the Packet, it is a good idea to specify it here.
The purpose of such entry is mainly informative: the user knows that a specific Data Model is used by the Packet and must be attached (and setup) to the scenario Player or any Entity using the Packet.
Retrieving the selected Data Model can be done this way:
 
if (strEqual(getDataModel(),"CigiEntity")) ...
 
8

Trace

8.
When checked, the console will output all data received or sent by the Packet. Tracing must be enabled globally, at the Settings level.
 
9

Monitor

9.
When checked, the Packet icon will change color according to the simulation engine information:
  • Greyed out: disabled
  • Black: socket created, no data
  • Magenta: data passing through (in or out)
 
10

Disabled

10.
If checked, the Packet will not be created and there will be no communication performed.
 
11

Settings

11. Settings
This dynamic interface is the translation of the public user data defined in Code::Declaration panel (see here) with //&& tags
It's purpose is to provide user an easy way to setup the data of the Packet.
 
 
Default All: Replace all values with the default ones found in DEF[] for each entries.
Rebuild All: Reparse the Code::Definitions part to sync the Interface. This is not done automatically as the rebuild process delete the current interface before reparsing and defaulting all the values.
 
In vsTASKER, a CIGI Packet object exists as one instance. It is a message producer. It can issue one message at a time (View Definition for example) or many (Entity Control) in sequence or according to some conditions for network optimization.
 
12

Code

12. Code
See here
 
13

Help

13. Help
Any description of the Packet can be put here and will be used for the automatic document generation (see Make Documents)
 

Contents of Packet Properties

Packet Code