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

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
(12 intermediate revisions by 2 users not shown)
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.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_SheepPen.fcfx FC_Comp_Source_SheepPen.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_SheepPen.fcfx FC_Comp_Source_SheepPen.fcfx]
 +
 +
==Detailed description==
 +
 +
  
  
  
−
==[[File:Component Icon fddf4a52_13cf_4a42_b4c5_d525e824a55a.png|Image]] 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.
 
  
−
==Examples==
 
−
There is a detailed walk through of the scenario detailed at the link below to go with this component.
 
  
−
[[Sheep_Pen|Sheep Pen Scenario]]
 
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ReadSensor</tt></u></span>===
 
−
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.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ControlGateB</tt></u></span>===
 
−
Allows gate B to be opened and closed.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''State''
 
−
::0 = Closed, 1 = Open
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<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''
 
  
 +
There is a detailed walk through of the scenario detailed at the link below to go with this component.
  
 +
[[Sheep_Pen|Sheep Pen Scenario]]
  
  
−
==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''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>Active Sensor</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ColB''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
 +
==Macro reference==
  
−
<span style="font-weight: normal;"><u>Num Objects</u></span>
+
===ControlGateA===
 +
{| 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;" | '''ControlGateA'''
 +
|-
 +
| colspan="2" | Allows gate A 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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumObjects''.
 
  
−
Specifies the number of objects active in the simulation.
+
===ControlGateB===
 +
{| 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''
 +
|}
 +
 
 +
 
 +
===ReadSensor===
 +
{| 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''
 +
|}
 +
 
 +
 
 +
==Property reference==
 +
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Inactive Sensor
 +
|-
 +
| colspan="2" | Specifies the colour of the sensor's indicator when no sheep are present.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Active Sensor
 +
|-
 +
| colspan="2" | Specifies the colour of the sensor's indicator when sheep are present.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Num Objects
 +
|-
 +
| colspan="2" | Specifies the number of objects active in the simulation.&nbsp;
 +
|}

Latest revision as of 13:12, 7 February 2023

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 Source Code

Please click here to download the component source project: FC_Comp_Source_SheepPen.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_SheepPen.fcfx

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






Macro reference

ControlGateA

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


ControlGateB

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


ReadSensor

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


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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Sheep_Pen_(Scenarios)&oldid=38325"