vsTASKER 7 User Manual
×
Menu
Index

General

 
General
1

Name

1. Name
Name of the Federate. Must be unique. A good practice is to put a minus p (or s) before the name to type it (i.e: pMyPublisher).
 
2

Mode

2. Mode
One Federate object cannot publish and subscribe using the same federate.
 
3

Categ

3. Categ
Chose if the Federate will handle Objects or Interactions.
 
4

Cycle at

4. Cycle at
For Publishers, the selected Objects or Interaction [Code] can be processed at requested frequency. If On_Event is selected, only the specified Event will trigger the Federate Code.
Both Frequency and Event can be combined.
 
5

Cycle on Event

5. Cycle on Event
Write here the triggering Event.
If several events can trigger the FedItem, separate them with commas.
 
6

Disabled

6. Disabled
If checked, the Federate will not be generated for the Simulation.
 
7

Trace

7. Trace
If checked, runtime console window will get more data to display.
Code generation will include numerous tracing printout.
This is CPU demanding so, useless for release systems.
 
8

Import / Export

8.
The FedItem can be exported as a file or can be imported from another (exported) file.
If imported, all current definitions will be replaced.
 
Exporting a FedItem can be useful to build a library or to exchange a FedItem from one database to one another.
It can be a good idea to create a subdirectory into the data/shared directory. One directory per FOM to avoid mixing FedItems from different FOM that would not work.
 
Exported FedItems can be imported from the contextual menu. Four kind of files are automatically selected:
1- Publishing Object (extension fpo)
2- Publishing Interaction (extension fpi)
3- Subscribing Object (extension fso)
4- Subscribing Interaction (extension fsi)
 
You can import any of them from the Import popup menu:
 
 
9

Used By List

9. Used By List
List here all entities (of any scenario) using this FedObject at runtime. This can be useful when combined with a Modeling Object as vsTASKER automatically generates some code to facilitate the data processing.
Use to select which entity of the current scenario to add.
Use to remove from the list the selected entity.
Uncheck entities that must not be processed at runtime.
 
10

Runtime Entity

10. Runtime Entity
When switched ON on a Publisher, any runtime entity on vsTASKER will be added to the FedItem and be ready to publish, unless discarded from the Register panel of the FedItem by setting the entity variable to NULL. If OFF, runtime entities will be ignored by the FedItem.
 
When switched ON on a Subscriber, the discover part (see the discover pane) will automatically create a "default" entity and will try to set the local pointer to the attached component (if found) for the next focus.
 
11

Data Model

11.
Select the corresponding DataModel.
The selected DataModel shall be a Class that does map the Class/Attributes or Interaction/Parameter of the current FedItem definition.
 
To understand how DataModel will be used by the code generator, let's get the above sample with hlaEntity DataModel selected.
 
With DataModel, the following variables will be declared into the corresponding FedItem class:
 
hlaEntity* local;     // automatically set for Objects, only under multiple instance mode.
hlaEntity  rti_data;  // only when Entity Based option is turned OFF