Designer Component Guide - Revision history

Rsalter: /* System Dynamics */

2022-06-08T15:01:59Z

System Dynamics

← Older revision		Revision as of 15:01, 8 June 2022
Line 104:		Line 104:

	==System Dynamics==		==System Dynamics==
			[[File:seqProp.png\|360px\|thumb\|right]]
	The two system dynamics components are initialized to specified values and update their contents on each cycle.		The two system dynamics components are initialized to specified values and update their contents on each cycle.
	===Sequence===		===Sequence===
	~~[[File:seqProp.png\|360px\|thumb\|right]]~~
	[[File:dseq.png]] A Sequence is determined by an initial value and an update computation executed on each cycle. Sequence type is not restricted.		[[File:dseq.png]] A Sequence is determined by an initial value and an update computation executed on each cycle. Sequence type is not restricted.
	;Property Pane		;Property Pane

Rsalter: /* System Dynamics */

2022-06-08T15:01:29Z

System Dynamics

← Older revision		Revision as of 15:01, 8 June 2022
Line 119:		Line 119:

	===Stock===		===Stock===
			[[File:stockProp.png\|360px\|thumb\|right]]
	[[File:dstock.png]] A Stock is similarly determined by an initial value and a flow computation executed on each cycle. The flow value is treated differently, however. Stocks are used to model continuous functions in which the flow acts as a derivative; consequently their update behavior is dictated by the choice of integration method. Stock types are restricted to Numerical types (Number, Double, Integer, etc.)		[[File:dstock.png]] A Stock is similarly determined by an initial value and a flow computation executed on each cycle. The flow value is treated differently, however. Stocks are used to model continuous functions in which the flow acts as a derivative; consequently their update behavior is dictated by the choice of integration method. Stock types are restricted to Numerical types (Number, Double, Integer, etc.)
	;Property Pane		;Property Pane
	~~[[File:stockProp.png\|360px\|thumb\|right]]~~
	:The Stock has two <span style="color:#E80404">'''Supplier'''</span> squib properties. ''Initial Value'' determines its initial value when the simulation is reset. ''Flow Value'' computes the value used by numerical integration to determine the next Stock value. Both must return values compatible with the specified type.		:The Stock has two <span style="color:#E80404">'''Supplier'''</span> squib properties. ''Initial Value'' determines its initial value when the simulation is reset. ''Flow Value'' computes the value used by numerical integration to determine the next Stock value. Both must return values compatible with the specified type.
	:;Non-Negative		:;Non-Negative

Rsalter: /* Sequence */

2022-06-08T15:01:04Z

Sequence

← Older revision		Revision as of 15:01, 8 June 2022
Line 106:		Line 106:
	The two system dynamics components are initialized to specified values and update their contents on each cycle.		The two system dynamics components are initialized to specified values and update their contents on each cycle.
	===Sequence===		===Sequence===
			[[File:seqProp.png\|360px\|thumb\|right]]
	[[File:dseq.png]] A Sequence is determined by an initial value and an update computation executed on each cycle. Sequence type is not restricted.		[[File:dseq.png]] A Sequence is determined by an initial value and an update computation executed on each cycle. Sequence type is not restricted.
	;Property Pane		;Property Pane
	~~[[File:seqProp.png\|360px\|thumb\|right]]~~
	:The Sequence has two <span style="color:#E80404">'''Supplier'''</span> squib properties. ''Initial Value'' determines its initial value when the simulation is reset. ''Next Value'' computes the value to be used in the next cycle. Both must return values compatible with the specified type.		:The Sequence has two <span style="color:#E80404">'''Supplier'''</span> squib properties. ''Initial Value'' determines its initial value when the simulation is reset. ''Next Value'' computes the value to be used in the next cycle. Both must return values compatible with the specified type.
	:;Record Full History		:;Record Full History

Rsalter: /* Term */

2022-06-08T15:00:29Z

Term

← Older revision		Revision as of 15:00, 8 June 2022
Line 91:		Line 91:

	===Term===		===Term===
			[[File:termProp.png\|360px\|thumb\|right]]
	[[File:dterm.png]] A Term is function of no arguments, defined by a <span style="color:#E80404">'''Supplier'''</span> squib.		[[File:dterm.png]] A Term is function of no arguments, defined by a <span style="color:#E80404">'''Supplier'''</span> squib.
	;Property Pane		;Property Pane
	~~[[File:termProp.png\|360px\|thumb\|right]]~~
	:The Term has single <span style="color:#E80404">'''Supplier'''</span> squib property specifying its value.		:The Term has single <span style="color:#E80404">'''Supplier'''</span> squib property specifying its value.
	:;Volatile		:;Volatile

Rsalter: /* Store */

2022-06-08T15:00:14Z

Store

← Older revision		Revision as of 15:00, 8 June 2022
Line 76:		Line 76:

	===Store===		===Store===
			[[File:funcProp.png\|360px\|thumb\|right]]
	[[File:dstore.png]] A Store is like a global variable in a programming language. It is initialized when the simulation is reset. Its value persists over the course of the simulation cycles unless changed using the ''update'' method.		[[File:dstore.png]] A Store is like a global variable in a programming language. It is initialized when the simulation is reset. Its value persists over the course of the simulation cycles unless changed using the ''update'' method.
	;Property Pane		;Property Pane
	~~[[File:storeProp.png\|360px\|thumb\|right]]~~
	:The Store has single <span style="color:#E80404">'''Supplier'''</span> squib property specifying its initial value.		:The Store has single <span style="color:#E80404">'''Supplier'''</span> squib property specifying its initial value.

Rsalter: /* Parameter */

2022-06-08T14:59:56Z

Parameter

← Older revision		Revision as of 14:59, 8 June 2022
Line 60:		Line 60:

	===Parameter===		===Parameter===
			[[File:paramProp0.png\|360px\|thumb\|right\|Constant Parameter]]
			[[File:paramProp1.png\|360px\|thumb\|right\|Slider Parameter]]
	[[File:dparam0.png]][[File:dparam1.png]] A Parameter is a numerical value (Double or Integer) provided either as a constant or specified with a Slider.		[[File:dparam0.png]][[File:dparam1.png]] A Parameter is a numerical value (Double or Integer) provided either as a constant or specified with a Slider.
	;Property Pane		;Property Pane
	~~[[File:paramProp0.png\|360px\|thumb\|right\|Constant Parameter]]~~
	~~[[File:paramProp1.png\|360px\|thumb\|right\|Slider Parameter]]~~
	:The constant Parameter value is entered into a text field. Integer or Double value type must be selected.		:The constant Parameter value is entered into a text field. Integer or Double value type must be selected.
	:Checking the ''User Slider'' box changes the green Parameter icon to a slider. The slider is configured here by specifying minimum and maximum extents of the slider range, and by specifying a step value. The step value is only used when the slider knob is clicked and the slider is moved up and down using arrow keys.		:Checking the ''User Slider'' box changes the green Parameter icon to a slider. The slider is configured here by specifying minimum and maximum extents of the slider range, and by specifying a step value. The step value is only used when the slider knob is clicked and the slider is moved up and down using arrow keys.
Line 74:		Line 74:

	<br clear="all">		<br clear="all">

	===Store===		===Store===
	[[File:dstore.png]] A Store is like a global variable in a programming language. It is initialized when the simulation is reset. Its value persists over the course of the simulation cycles unless changed using the ''update'' method.		[[File:dstore.png]] A Store is like a global variable in a programming language. It is initialized when the simulation is reset. Its value persists over the course of the simulation cycles unless changed using the ''update'' method.

Rsalter: /* Function */

2022-06-08T14:59:35Z

Function

← Older revision		Revision as of 14:59, 8 June 2022
Line 47:		Line 47:

	===Function===		===Function===
			[[File:funcProp.png\|360px\|thumb\|right]]
	[[File:dfunction.png]] A Function contains a <span style="color:#21a0ff">'''Function'''</span> squib that is executed only when the function defined by the squib is invoked on a set of arguments. Function squibs are defined [[Quick Programming References#Function \| here]].		[[File:dfunction.png]] A Function contains a <span style="color:#21a0ff">'''Function'''</span> squib that is executed only when the function defined by the squib is invoked on a set of arguments. Function squibs are defined [[Quick Programming References#Function \| here]].
	;Property Pane		;Property Pane
	~~[[File:funcProp.png\|360px\|thumb\|right]]~~
	:Contains a single <span style="color:#21a0ff">'''Function'''</span> squib. Return type is required.		:Contains a single <span style="color:#21a0ff">'''Function'''</span> squib. Return type is required.
	:;Volatile		:;Volatile

Rsalter: /* Command */

2022-06-08T14:59:19Z

Command

← Older revision		Revision as of 14:59, 8 June 2022
Line 20:		Line 20:
	==Basic Components==		==Basic Components==
	===Command===		===Command===
			[[File:commandProp.png\|360px\|Thumb\|right]]
	[[File: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.		[[File: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		;Property Pane
	~~[[File:commandProp.png\|360px\|Thumb\|right]]~~
	:Contains a single <span style="color:#ff8c00">'''Command'''</span> squib.		:Contains a single <span style="color:#ff8c00">'''Command'''</span> squib.

Rsalter: /* Constant */

2022-06-08T14:58:59Z

Constant

← Older revision		Revision as of 14:58, 8 June 2022
Line 37:		Line 37:

	===Constant===		===Constant===
			[[File:constProp.png\|360px\|thumb\|right]]
	[[File:dconstant.png]] A Constant contains a <span style="color:#e80404">'''Supplier'''</span> squib that is executed once when the simulation is reset. The value is retained for the life of the simulation.		[[File:dconstant.png]] A Constant contains a <span style="color:#e80404">'''Supplier'''</span> squib that is executed once when the simulation is reset. The value is retained for the life of the simulation.
	;Property Pane		;Property Pane
	~~[[File:constProp.png\|360px\|thumb\|right]]~~
	:Contains a single <span style="color:#e80404">'''Supplier'''</span> squib. Return type is required.		:Contains a single <span style="color:#e80404">'''Supplier'''</span> squib. Return type is required.
	;Squib Reference		;Squib Reference

Rsalter: /* Command */

2022-06-08T14:58:32Z

Command

← Older revision		Revision as of 14:58, 8 June 2022
Line 20:		Line 20:
	==Basic Components==		==Basic Components==
	===Command===		===Command===
	[[File: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.		[[File: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		;Property Pane