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

From Flowcode Help
Jump to navigationJump to search
 
(One intermediate revision by the same user 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 Pack==
−
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==
+
SCADA
  
−
===Industrial Tanks===
+
==Detailed description==
  
−
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
 
  
−
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
 
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
''This component does not contain any downloadable macros''
+
==Examples==
  
−
==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''
 
  
 +
===Industrial Tanks===
  
−
'''Return value'''
+
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
  
−
:''This call does not return a value''
+
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
  
 +
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>GetLevel</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Returns the current amount of produce in the hopper.
+
|-
 +
| 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''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| 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''
 +
|}
  
  
−
'''Return value'''
+
{| 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''
 +
|}
  
−
:[[Variable Types|FLOAT]]
 
  
 +
{| 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''
 +
|}
  
−
===<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.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLevel'''
−
:''This macro has no parameters''
+
|-
−
 
+
| colspan="2" | Sets the current amount of produce in the hopper.&nbsp;
−
 
+
|-
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+
| width="90%" | Level
−
 
+
|-
−
 
+
| colspan="2" | The amount of produce in the hopper.&nbsp;
−
===<span style="font-weight: normal;"><u><tt>IsEmpty</tt></u></span>===
+
|-
−
Check to see if the hopper is currently empty.
+
| 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''
−
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>===
 
−
Sets the current amount of produce in the hopper.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Level''
 
−
::The amount of produce in the hopper.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 108: Line 117:
  
 
==Property reference==
 
==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''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Maximum amount of produce that can be stored in the hopper.
+
| 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>Default State</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Default_State''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Max Produce
−
The initial state of the volume of produce in the hopper when the runtime starts
+
|-
−
 
+
| colspan="2" | Maximum amount of produce that can be stored in the hopper.&nbsp;
−
<span style="font-weight: normal;"><u>Plot Waveform</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 ''PlotWave''.
+
| width="90%" | Default State
−
 
+
|-
−
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window.
+
| colspan="2" | The initial state of the volume of produce in the hopper when the runtime starts&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show Title</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Plot Waveform
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.
+
|-
−
 
+
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window.&nbsp;
−
Decides if the hopper title is shown
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Title Colour</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Title Label Color
+
| width="90%" | Show Title
−
 
+
|-
−
<span style="font-weight: normal;"><u>Title Text</u></span>
+
| colspan="2" | Decides if the hopper title is shown&nbsp;
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Title Colour
−
Title Label Text
+
|-
−
 
+
| colspan="2" | Title Label Color&nbsp;
−
<span style="font-weight: normal;"><u>Title 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 ''TitleScale''.
+
| width="90%" | Title Text
−
 
+
|-
−
Controls the size of the title text on the panel, default 1.2
+
| colspan="2" | Title Label Text&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show Label</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Title Scale
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowLabel''.
+
|-
−
 
+
| colspan="2" | Controls the size of the title text on the panel, default 1.2&nbsp;
−
Decides if a label is shown detailing current amount of produce in the hopper
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Label Colour</u></span>
+
| width="90%" | Title Offset
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''LabelColour''.
+
| colspan="2" | Distance above component center to draw the title&nbsp;
−
 
+
|-
−
Sets the label colour
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
−
<span style="font-weight: normal;"><u>Label Units</u></span>
+
|-
−
 
+
|-
−
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]]
−
 
+
| width="90%" | Show Label
−
Adds a unit to the end of the label
+
|-
−
 
+
| colspan="2" | Decides if a label is shown detailing current amount of produce in the hopper&nbsp;
−
<span style="font-weight: normal;"><u>Label Decimal Points</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LabelDecPoints''.
+
| width="90%" | Label Colour
−
 
+
|-
−
Number of decimal points to round the label value to.
+
| colspan="2" | Sets the label colour&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Scale</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Label Units
−
This property is of type ''Floating point'' and can be referenced with the variable name ''LabelScale''.
+
|-
−
 
+
| colspan="2" | Adds a unit to the end of the label&nbsp;
−
Sets the size of the label on the panel, default 1.0
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>Hopper Colour</u></span>
+
| width="90%" | Label Decimal Points
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''HopperColour''.
+
| colspan="2" | Number of decimal points to round the label value to.&nbsp;
−
 
+
|-
−
Sets the colour for the hopper
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Label Scale
−
<span style="font-weight: normal;"><u>Produce Colour</u></span>
+
|-
−
 
+
| colspan="2" | Sets the size of the label on the panel, default 1.0&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ProduceColour''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
Sets the colour for the produce
+
| 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 17:22, 9 November 2022

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 Pack

SCADA

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

Downloadable 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/wikiv9/index.php?title=Component:_Hopper_(Industrial)&oldid=28717"