Difference between revisions of "Designer Component Guide"

From Numerus
Jump to navigation Jump to search
Line 28: Line 28:
;Property Pane
;Property Pane
[[File:constProp.png|360px|thumb|right]] Contains a single <span style="color:#ff8c00">'''Supplier'''</span> squib.
[[File:constProp.png|360px|thumb|right]] Contains a single <span style="color:#ff8c00">'''Supplier'''</span> squib.
 
</div>
<br clear="all">
<div id="Function">
===Function===
[[File:dfunc.png]]
</div>
</div>

Revision as of 16:26, 7 June 2022

This guide documents the Component set distributed with Numerus Designer. Numerus Designer models are constructed out of Components, which are visual tokens that are placed on the Design Canvas.

To place a component on the model canvas:

  • Press the left mouse button on the desired Component in the Component Palette.
  • Drag the component from the component menu onto the Design Canvas.
  • A default name will be provided; Alt-click on the name to change it (or change it in the Property Pane).
  • The new component must be programmed; this may require the programming of squibs. See Programming References for a discussion of squib programming.

Basic Components

Command

Dcommand.png A command contains code that is executed once per time step. Commands do not return values; rather they operate by altering simulation state, often through the execution of some primitive operator. One common use for a Command is during program development, where the Console.log primop is used to print useful values to the console. Another important role is in the agent life cycle, where Commands may contain code used to create or terminate agents, or move them in their environment.

Property Pane
Thumb
Contains a single Command squib.
Observer
If checked, this Command is not executed during the normal Simulation cycle, but rather intentionally from a remote Observer, such as an Agent Vector Component, or from some other Component. Intentional Command invocation follows the same pattern as Term invocation.
Volatile
Normally Components are executed only once per cycle. If Volatile is checked, it enables multiple executions.


Constant

Dconstant.png A Constant contains a Supplier squib that is executed once when the simulation is reset. The value is retained for the life of the simulation.

Property Pane
ConstProp.png
Contains a single Supplier squib.


Function

Dfunc.png