Component: Hopper (Industrial): Difference between revisions
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
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. | 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 | ==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] | |||
==Detailed description== | ==Detailed description== | ||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| Line 134: | Line 138: | ||
|- | |- | ||
| 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" 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="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 159: | Line 167: | ||
|- | |- | ||
| colspan="2" | Distance above component center to draw the title | | 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="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 189: | Line 201: | ||
|- | |- | ||
| colspan="2" | Distance above component center to draw the value | | 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="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| Line 199: | Line 215: | ||
|- | |- | ||
| colspan="2" | Sets the colour for the produce | | colspan="2" | Sets the colour for the produce | ||
|} | |} | ||
Revision as of 17:47, 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 Source Code
Please click here for the component source code: 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.
Downloadable macro reference
|
AdjustLevel |
| Allows the lelev in the hopper to be adjusted up or down. | |
 - FLOAT
|
Adjustment |
 - VOID
|
Return |
|
|
GetLevel |
| Returns the current amount of produce in the hopper. | |
| - FLOAT
|
Return |
|
|
IsFull |
| Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. | |
 - BOOL
|
Return |
|
|
IsEmpty |
| Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. | |
| - BOOL
|
Return |
|
|
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 | |