Difference between revisions of "Component: Hopper (Industrial)"

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_Hopper.fcfx FC_Comp_Source_Hopper.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Hopper.fcfx FC_Comp_Source_Hopper.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 30: Line 32:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 46: Line 50:
  
 
==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;" | '''AdjustLevel'''
 +
|-
 +
| colspan="2" | Allows the lelev in the hopper to be adjusted up or down. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Adjustment
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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;" | '''GetLevel'''
 +
|-
 +
| colspan="2" | Returns the current amount of produce in the hopper. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| 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;" | '''IsFull'''
 +
|-
 +
| colspan="2" | Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
 +
|-
 +
|-
 +
| 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;" | '''IsEmpty'''
 +
|-
 +
| colspan="2" | Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
 +
|-
 +
|-
 +
| 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;" | '''SetLevel'''
 +
|-
 +
| colspan="2" | Sets the current amount of produce in the hopper. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Level
 +
|-
 +
| colspan="2" | The amount of produce in the hopper. 
 +
|-
 +
| 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-15-icon.png]]
 +
| width="90%" | Max Produce
 +
|-
 +
| colspan="2" | Maximum amount of produce that can be stored in the hopper. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Default State
 +
|-
 +
| colspan="2" | The initial state of the volume of produce in the hopper when the runtime starts 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Plot Waveform
 +
|-
 +
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Title
 +
|-
 +
| colspan="2" | Decides if the hopper title is shown 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Title Colour
 +
|-
 +
| colspan="2" | Title Label Color 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Title Text
 +
|-
 +
| colspan="2" | Title Label Text 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Title Scale
 +
|-
 +
| colspan="2" | Controls the size of the title text on the panel, default 1.2 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Title Offset
 +
|-
 +
| colspan="2" | Distance above component center to draw the title 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Label
 +
|-
 +
| colspan="2" | Decides if a label is shown detailing current amount of produce in the hopper 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label Colour
 +
|-
 +
| colspan="2" | Sets the label colour 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Label Units
 +
|-
 +
| colspan="2" | Adds a unit to the end of the label 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Label Decimal Points
 +
|-
 +
| colspan="2" | Number of decimal points to round the label value to. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Label Scale
 +
|-
 +
| colspan="2" | Sets the size of the label on the panel, default 1.0 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Label Offset
 +
|-
 +
| colspan="2" | Distance above component center to draw the value 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Hopper Colour
 +
|-
 +
| colspan="2" | Sets the colour for the hopper 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Produce Colour
 +
|-
 +
| colspan="2" | Sets the colour for the produce 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:15, 20 January 2023

Author Matrix TSL
Version 1.0
Category Industrial


Hopper component

A simple hopper that can be used to store produce. The hopper has component macros to set and get the current level of produce. The hopper can be initialised to be full or empty when starting. Compatible with SCADA interconnecting pipe components.

Component Source Code

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

Detailed description

No detailed description exists yet for this component

Examples

Industrial Tanks

A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.

FC6 Icon.png Industrial Tanks

Macro reference

Fc9-comp-macro.png AdjustLevel
Allows the lelev in the hopper to be adjusted up or down. 
Fc9-f32-icon.png - FLOAT Adjustment
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetLevel
Returns the current amount of produce in the hopper. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png IsFull
Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png IsEmpty
Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png SetLevel
Sets the current amount of produce in the hopper. 
Fc9-f32-icon.png - FLOAT Level
The amount of produce in the hopper. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Max Produce
Maximum amount of produce that can be stored in the hopper. 
Fc9-type-16-icon.png Default State
The initial state of the volume of produce in the hopper when the runtime starts 
Fc9-type-7-icon.png Plot Waveform
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
Fc9-conn-icon.png Title
Fc9-type-7-icon.png Show Title
Decides if the hopper title is shown 
Fc9-type-1-icon.png Title Colour
Title Label Color 
Fc9-type-10-icon.png Title Text
Title Label Text 
Fc9-type-15-icon.png Title Scale
Controls the size of the title text on the panel, default 1.2 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-conn-icon.png Label
Fc9-type-7-icon.png Show Label
Decides if a label is shown detailing current amount of produce in the hopper 
Fc9-type-1-icon.png Label Colour
Sets the label colour 
Fc9-type-10-icon.png Label Units
Adds a unit to the end of the label 
Fc9-type-21-icon.png Label Decimal Points
Number of decimal points to round the label value to. 
Fc9-type-15-icon.png Label Scale
Sets the size of the label on the panel, default 1.0 
Fc9-type-15-icon.png Label Offset
Distance above component center to draw the value 
Fc9-conn-icon.png Scheme
Fc9-type-1-icon.png Hopper Colour
Sets the colour for the hopper 
Fc9-type-1-icon.png Produce Colour
Sets the colour for the produce 

==Macro reference==

Fc9-comp-macro.png AdjustLevel
Allows the lelev in the hopper to be adjusted up or down. 
Fc9-f32-icon.png - FLOAT Adjustment
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetLevel
Returns the current amount of produce in the hopper. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png IsFull
Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png IsEmpty
Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png SetLevel
Sets the current amount of produce in the hopper. 
Fc9-f32-icon.png - FLOAT Level
The amount of produce in the hopper. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Max Produce
Maximum amount of produce that can be stored in the hopper. 
Fc9-type-16-icon.png Default State
The initial state of the volume of produce in the hopper when the runtime starts 
Fc9-type-7-icon.png Plot Waveform
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
Fc9-conn-icon.png Title
Fc9-type-7-icon.png Show Title
Decides if the hopper title is shown 
Fc9-type-1-icon.png Title Colour
Title Label Color 
Fc9-type-10-icon.png Title Text
Title Label Text 
Fc9-type-15-icon.png Title Scale
Controls the size of the title text on the panel, default 1.2 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-conn-icon.png Label
Fc9-type-7-icon.png Show Label
Decides if a label is shown detailing current amount of produce in the hopper 
Fc9-type-1-icon.png Label Colour
Sets the label colour 
Fc9-type-10-icon.png Label Units
Adds a unit to the end of the label 
Fc9-type-21-icon.png Label Decimal Points
Number of decimal points to round the label value to. 
Fc9-type-15-icon.png Label Scale
Sets the size of the label on the panel, default 1.0 
Fc9-type-15-icon.png Label Offset
Distance above component center to draw the value 
Fc9-conn-icon.png Scheme
Fc9-type-1-icon.png Hopper Colour
Sets the colour for the hopper 
Fc9-type-1-icon.png Produce Colour
Sets the colour for the produce 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Hopper_(Industrial)&oldid=32639"