Component: Hopper (Industrial)
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | Industrial |
Contents
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.
Examples
Industrial Tanks
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
AdjustLevel
Allows the lelev in the hopper to be adjusted up or down.
Parameters
- FLOAT Adjustment
Return value
- This call does not return a value
GetLevel
Returns the current amount of produce in the hopper.
Parameters
- This macro has no parameters
Return value
IsFull
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
- BOOL : Returns true if the operation is a success, else false
IsEmpty
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
- BOOL : Returns true if the operation is a success, else false
SetLevel
Sets the current amount of produce in the hopper.
Parameters
- FLOAT Level
- The amount of produce in the hopper.
Return value
- This call does not return a value
Property reference
Max Produce
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.
Default State
This property is of type Fixed list of ints and can be referenced with the variable name Default_State.
The initial state of the volume of produce in the hopper when the runtime starts
Plot Waveform
This property is of type True or false and can be referenced with the variable name PlotWave.
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window.
Show Title
This property is of type True or false and can be referenced with the variable name ShowTitle.
Decides if the hopper title is shown
Title Colour
This property is of type Color picker and can be referenced with the variable name TitleColour.
Title Label Color
Title Text
This property is of type Line of text and can be referenced with the variable name TitleText.
Title Label Text
Title Scale
This property is of type Floating point and can be referenced with the variable name TitleScale.
Controls the size of the title text on the panel, default 1.2
Show Label
This property is of type True or false and can be referenced with the variable name ShowLabel.
Decides if a label is shown detailing current amount of produce in the hopper
Label Colour
This property is of type Color picker and can be referenced with the variable name LabelColour.
Sets the label colour
Label Units
This property is of type Line of text and can be referenced with the variable name LabelUnits.
Adds a unit to the end of the label
Label Decimal Points
This property is of type Unsigned integer and can be referenced with the variable name LabelDecPoints.
Number of decimal points to round the label value to.
Label Scale
This property is of type Floating point and can be referenced with the variable name LabelScale.
Sets the size of the label on the panel, default 1.0
Hopper Colour
This property is of type Color picker and can be referenced with the variable name HopperColour.
Sets the colour for the hopper
Produce Colour
This property is of type Color picker and can be referenced with the variable name ProduceColour.
Sets the colour for the produce
