Component: Hopper (Industrial): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 62: | Line 62: | ||
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}} | {{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}} | ||
| Line 67: | Line 75: | ||
==Macro reference== | ==Macro reference== | ||
{| class="wikitable | ===AdjustLevel=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''AdjustLevel''' | ||
|- | |- | ||
| colspan="2" | Allows the lelev in the hopper to be adjusted up or down. | | colspan="2" | Allows the lelev in the hopper to be adjusted up or down. | ||
| Line 85: | Line 94: | ||
{| class="wikitable | ===GetLevel=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetLevel''' | ||
|- | |- | ||
| colspan="2" | Returns the current amount of produce in the hopper. | | colspan="2" | Returns the current amount of produce in the hopper. | ||
| Line 98: | Line 108: | ||
{| class="wikitable | ===IsEmpty=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''IsEmpty''' | ||
|- | |- | ||
| colspan="2" | Check to see if the hopper is currently | | colspan="2" | Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. | ||
|- | |- | ||
|- | |- | ||
| Line 111: | Line 122: | ||
{| class="wikitable | ===IsFull=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''IsFull''' | ||
|- | |- | ||
| colspan="2" | Check to see if the hopper is currently | | colspan="2" | Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. | ||
|- | |- | ||
|- | |- | ||
| Line 124: | Line 136: | ||
{| class="wikitable | ===SetLevel=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetLevel''' | ||
|- | |- | ||
| colspan="2" | Sets the current amount of produce in the hopper. | | colspan="2" | Sets the current amount of produce in the hopper. | ||
| Line 140: | Line 153: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 167: | Line 178: | ||
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. | | colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Title | ||
|- | |- | ||
|- | |- | ||
| Line 196: | Line 207: | ||
| colspan="2" | Distance above component center to draw the title | | colspan="2" | Distance above component center to draw the title | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Label | ||
|- | |- | ||
|- | |- | ||
| Line 230: | Line 241: | ||
| colspan="2" | Distance above component center to draw the value | | colspan="2" | Distance above component center to draw the value | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Scheme | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| 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.
Macro reference
AdjustLevel
|
AdjustLevel |
| Allows the lelev in the hopper to be adjusted up or down. | |
 - FLOAT
|
Adjustment |
 - VOID
|
Return |
GetLevel
|
|
GetLevel |
| Returns the current amount of produce in the hopper. | |
| - FLOAT
|
Return |
IsEmpty
|
|
IsEmpty |
| Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. | |
 - BOOL
|
Return |
IsFull
|
|
IsFull |
| Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. | |
| - BOOL
|
Return |
SetLevel
|
|
SetLevel |
| Sets the current amount of produce in the hopper. | |
| - FLOAT
|
Level |
| The amount of produce in the hopper. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Max Produce |
| Maximum amount of produce that can be stored in the hopper. | |
|
Default State |
| The initial state of the volume of produce in the hopper when the runtime starts | |
|
Plot Waveform |
| Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. | |
|
Title |
|
|
Show Title |
| Decides if the hopper title is shown | |
|
Title Colour |
| Title Label Color | |
|
Title Text |
| Title Label Text | |
|
|
Title Scale |
| Controls the size of the title text on the panel, default 1.2 | |
|
|
Title Offset |
| Distance above component center to draw the title | |
|
|
Label |
|
|
Show Label |
| Decides if a label is shown detailing current amount of produce in the hopper | |
|
|
Label Colour |
| Sets the label colour | |
|
|
Label Units |
| Adds a unit to the end of the label | |
|
Label Decimal Points |
| Number of decimal points to round the label value to. | |
|
|
Label Scale |
| Sets the size of the label on the panel, default 1.0 | |
|
|
Label Offset |
| Distance above component center to draw the value | |
|
|
Scheme |
|
|
Hopper Colour |
| Sets the colour for the hopper | |
|
|
Produce Colour |
| Sets the colour for the produce | |