Difference between revisions of "Component: Sheep Pen (Scenarios)"

From Flowcode Help
Jump to navigationJump to search
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Scenarios
 
| Scenarios
 
|}
 
|}
  
  
 +
==Sheep Pen component==
 +
A simple sheep pen simulation with two gates and two sensors. Allows for simple logical control to try and move all the sheep from one pen to another.
  
−
==[[File:Component Icon fddf4a52_13cf_4a42_b4c5_d525e824a55a.png|Image]] Sheep Pen component==
+
==Component Pack==
−
A simple sheep pen simulation with two gates and two sensors.
 
−
Allows for simple logical control to try and move all the sheep from one pen to another.
 
  
−
==Examples==
+
FREE
−
There is a detailed walk through of the scenario detailed at the link below to go with this component.
 
  
−
[[Sheep_Pen|Sheep Pen Scenario]]
+
==Detailed description==
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
''This component does not contain any downloadable macros''
+
==Examples==
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ReadSensor</tt></u></span>===
+
There is a detailed walk through of the scenario detailed at the link below to go with this component.
−
Checks to see if an object is on the Sensor.
 
  
−
Returns 0 if nothing is on the Sensor, Returns 1 if an object is on the Sensor.
+
[[Sheep_Pen|Sheep Pen Scenario]]
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:''This macro has no parameters''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadSensor'''
 +
|-
 +
| colspan="2" | Checks to see if an object is on the Sensor. Returns 0 if nothing is on the Sensor, Returns 1 if an object is on the Sensor.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlGateB'''
 +
|-
 +
| colspan="2" | Allows gate B to be opened and closed.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0 = Closed, 1 = Open&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
===<span style="font-weight: normal;"><u><tt>ControlGateB</tt></u></span>===
+
|-
−
Allows gate B to be opened and closed.
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlGateA'''
−
'''Parameters'''
+
|-
−
 
+
| colspan="2" | Allows gate A to be opened and closed.&nbsp;
−
:[[Variable Types|BOOL]] ''State''
+
|-
−
::0 = Closed, 1 = Open
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
 
+
| width="90%" | State
−
'''Return value'''
+
|-
−
 
+
| colspan="2" | 0 = Closed, 1 = Open&nbsp;
−
:''This call does not return a value''
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
===<span style="font-weight: normal;"><u><tt>ControlGateA</tt></u></span>===
+
|}
−
Allows gate A to be opened and closed.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BOOL]] ''State''
 
−
::0 = Closed, 1 = Open
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 76: Line 84:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Inactive Sensor</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ColA''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Specifies the colour of the sensor's indicator when no sheep are present.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Active Sensor</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Inactive Sensor
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ColB''.
+
|-
−
 
+
| colspan="2" | Specifies the colour of the sensor's indicator when no sheep are present.&nbsp;
−
Specifies the colour of the sensor's indicator when sheep are present.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Active Sensor
−
 
+
|-
−
<span style="font-weight: normal;"><u>Num Objects</u></span>
+
| colspan="2" | Specifies the colour of the sensor's indicator when sheep are present.&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumObjects''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Num Objects
−
Specifies the number of objects active in the simulation.
+
|-
 +
| colspan="2" | Specifies the number of objects active in the simulation.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
 +
|-
 +
|}

Revision as of 16:25, 7 January 2022

Author Matrix TSL
Version 1.0
Category Scenarios


Sheep Pen component

A simple sheep pen simulation with two gates and two sensors. Allows for simple logical control to try and move all the sheep from one pen to another.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

There is a detailed walk through of the scenario detailed at the link below to go with this component.

Sheep Pen Scenario

Downloadable macro reference

Fc9-comp-macro.png ReadSensor
Checks to see if an object is on the Sensor. Returns 0 if nothing is on the Sensor, Returns 1 if an object is on the Sensor. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png ControlGateB
Allows gate B to be opened and closed. 
Fc9-bool-icon.png - BOOL State
0 = Closed, 1 = Open 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ControlGateA
Allows gate A to be opened and closed. 
Fc9-bool-icon.png - BOOL State
0 = Closed, 1 = Open 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-1-icon.png Inactive Sensor
Specifies the colour of the sensor's indicator when no sheep are present. 
Fc9-type-1-icon.png Active Sensor
Specifies the colour of the sensor's indicator when sheep are present. 
Fc9-type-16-icon.png Num Objects
Specifies the number of objects active in the simulation. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Sheep_Pen_(Scenarios)&oldid=27914"