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 to download the component source project: [https://www.flowcode.co.uk/ | + | 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] | 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 36: | Line 38: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 53: | Line 57: | ||
==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 09:59, 27 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Scenarios |
Contents
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.
Macro reference
|
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. | |
 - BOOL
|
Return |
|
|
ControlGateB |
| Allows gate B to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
 - VOID
|
Return |
|
|
ControlGateA |
| Allows gate A to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Inactive Sensor |
| Specifies the colour of the sensor's indicator when no sheep are present. | |
|
|
Active Sensor |
| Specifies the colour of the sensor's indicator when sheep are present. | |
|
Num Objects |
| Specifies the number of objects active in the simulation. | |
==Macro reference==
|
|
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. | |
| - BOOL
|
Return |
|
|
ControlGateB |
| Allows gate B to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
|
|
ControlGateA |
| Allows gate A to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Inactive Sensor |
| Specifies the colour of the sensor's indicator when no sheep are present. | |
|
|
Active Sensor |
| Specifies the colour of the sensor's indicator when sheep are present. | |
|
|
Num Objects |
| Specifies the number of objects active in the simulation. | |
==Macro reference==
|
|
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. | |
| - BOOL
|
Return |
|
|
ControlGateB |
| Allows gate B to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
|
|
ControlGateA |
| Allows gate A to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Inactive Sensor |
| Specifies the colour of the sensor's indicator when no sheep are present. | |
|
|
Active Sensor |
| Specifies the colour of the sensor's indicator when sheep are present. | |
|
|
Num Objects |
| Specifies the number of objects active in the simulation. | |
==Macro reference==
|
|
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. | |
| - BOOL
|
Return |
|
|
ControlGateB |
| Allows gate B to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
|
|
ControlGateA |
| Allows gate A to be opened and closed. | |
| - BOOL
|
State |
| 0 = Closed, 1 = Open | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Inactive Sensor |
| Specifies the colour of the sensor's indicator when no sheep are present. | |
|
|
Active Sensor |
| Specifies the colour of the sensor's indicator when sheep are present. | |
|
|
Num Objects |
| Specifies the number of objects active in the simulation. | |
