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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(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
 
| Industrial
 
| 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.
  
−
==[[File:Component Icon cc493328_7354_44de_b2f1_b70afac30dff.png|Image]] Hopper component==
+
==Component Source Code==
−
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.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Hopper.fcfx FC_Comp_Source_Hopper.fcfx]
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
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]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>AdjustLevel</tt></u></span>===
 
−
Allows the lelev in the hopper to be adjusted up or down.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Adjustment''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetLevel</tt></u></span>===
 
−
Returns the current amount of produce in the hopper.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>IsFull</tt></u></span>===
 
−
Check to see if the hopper is currently full.
 
  
−
Returns 0 if not full or 1 if full.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
−
===<span style="font-weight: normal;"><u><tt>IsEmpty</tt></u></span>===
 
−
Check to see if the hopper is currently empty.
 
  
−
Returns 0 if not empty or 1 if empty.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetLevel</tt></u></span>===
+
===Industrial Tanks===
−
Sets the current amount of produce in the hopper.
 
  
−
'''Parameters'''
+
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
  
−
:[[Variable Types|FLOAT]] ''Level''
+
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
−
::The amount of produce in the hopper.
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Max Produce</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''MaxVolume''.
 
  
−
Maximum amount of produce that can be stored in the hopper.
 
  
−
<span style="font-weight: normal;"><u>Default State</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Default_State''.
+
==Macro reference==
  
−
The initial state of the volume of produce in the hopper when the runtime starts
+
===AdjustLevel===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Adjustment
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Plot Waveform</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''PlotWave''.
+
===GetLevel===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window.
 
  
−
<span style="font-weight: normal;"><u>Show Title</u></span>
+
===IsEmpty===
 +
{| 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.&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''
 +
|}
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.
 
  
−
Decides if the hopper title is shown
+
===IsFull===
 +
{| 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.&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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Title Colour</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
+
===SetLevel===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Level
 +
|-
 +
| colspan="2" | The amount of produce in the hopper.&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''
 +
|}
  
−
Title Label Color
 
  
−
<span style="font-weight: normal;"><u>Title Text</u></span>
+
==Property reference==
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Title Label Text
+
| 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>Title Scale</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Max Produce
−
Controls the size of the title text on the panel, default 1.2
+
|-
−
 
+
| colspan="2" | Maximum amount of produce that can be stored in the hopper.&nbsp;
−
<span style="font-weight: normal;"><u>Show Label</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowLabel''.
+
| width="90%" | Default State
−
 
+
|-
−
Decides if a label is shown detailing current amount of produce in the hopper
+
| colspan="2" | The initial state of the volume of produce in the hopper when the runtime starts&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Colour</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Plot Waveform
−
This property is of type ''Color picker'' and can be referenced with the variable name ''LabelColour''.
+
|-
−
 
+
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window.&nbsp;
−
Sets the label colour
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Label Units</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''LabelUnits''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Adds a unit to the end of the label
+
| width="90%" | Show Title
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Decimal Points</u></span>
+
| colspan="2" | Decides if the hopper title is shown&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LabelDecPoints''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Title Colour
−
Number of decimal points to round the label value to.
+
|-
−
 
+
| colspan="2" | Title Label Color&nbsp;
−
<span style="font-weight: normal;"><u>Label Scale</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''LabelScale''.
+
| width="90%" | Title Text
−
 
+
|-
−
Sets the size of the label on the panel, default 1.0
+
| colspan="2" | Title Label Text&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Hopper Colour</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Title Scale
−
This property is of type ''Color picker'' and can be referenced with the variable name ''HopperColour''.
+
|-
−
 
+
| colspan="2" | Controls the size of the title text on the panel, default 1.2&nbsp;
−
Sets the colour for the hopper
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Produce Colour</u></span>
+
| width="90%" | Title Offset
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ProduceColour''.
+
| colspan="2" | Distance above component center to draw the title&nbsp;
−
 
+
|-
−
Sets the colour for the produce
+
| 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&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label Colour
 +
|-
 +
| colspan="2" | Sets the label colour&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Label Offset
 +
|-
 +
| colspan="2" | Distance above component center to draw the value&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Produce Colour
 +
|-
 +
| colspan="2" | Sets the colour for the produce&nbsp;
 +
|}

Latest revision as of 13:10, 7 February 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 download the component source project: FC_Comp_Source_Hopper.fcfx

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

AdjustLevel

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


GetLevel

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


IsEmpty

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


IsFull

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


SetLevel

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=38067"