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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/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==
 
==Detailed description==
 +
 +
  
  
Line 30: Line 32:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 43: Line 47:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0 = Closed, 1 = Open 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0 = Closed, 1 = Open 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==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. 
 +
|-
 +
| 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. 
 +
|-
 +
| 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. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:17, 20 January 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 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

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. 

==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.