Difference between revisions of "Component: Digital Valve (Industrial)"

From Flowcode Help
Jump to navigationJump to search
 
(11 intermediate revisions 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
 
|}
 
|}
 +
 +
 +
==Digital Valve component==
 +
A simple digital valve that can be either open or closed.  The valve has component macros to set and get the current state of the valve. The valve can be initialised to be open or closed when starting. The valve can be clicked to open or close via the runtime. Compatible with SCADA interconnecting pipe components.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Valve.fcfx FC_Comp_Source_Valve.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Valve.fcfx FC_Comp_Source_Valve.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon 9415f6ca_f29a_46cc_b3e8_f047cf0c598a.png|Image]] Digital Valve component==
 
−
A simple digital valve that can be either open or closed.
 
−
The valve has component macros to set and get the current state of the valve.
 
−
The valve can be initialised to be open or closed when starting.
 
−
The valve can be clicked to open or close via the runtime.
 
−
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.
+
''No detailed description exists yet for this component''
  
−
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
+
==Examples==
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetState</tt></u></span>===
 
−
Returns the current state of the valve.
 
  
−
0 = Closed
 
  
−
1 = Open
 
  
−
'''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>SetState</tt></u></span>===
 
−
Sets the current state of the valve.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''State''
 
−
::0 = Closed, 1 = Open
 
  
  
−
'''Return value'''
+
===Industrial Tanks===
  
−
:''This call does not return a value''
+
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
  
 +
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
  
  
  
−
==Property reference==
 
−
<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''.
 
  
−
The initial state of the valve when the runtime starts
 
  
−
<span style="font-weight: normal;"><u>Current State</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Current_State''.
 
  
−
The current state of the valve.
 
  
−
<span style="font-weight: normal;"><u>Orientation</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Orientation''.
 
  
−
The orientation of the valve on the panel.
+
==Macro reference==
  
−
<span style="font-weight: normal;"><u>Clickable</u></span>
+
===GetState===
 +
{| 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;" | '''GetState'''
 +
|-
 +
| colspan="2" | Returns the current state of the valve. 0 = Closed 1 = Open&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 ''Clickable''.
 
  
−
Dictates if the valve handle ca be clicked during runtime to open or close the valve,
+
===SetState===
 +
{| 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;" | '''SetState'''
 +
|-
 +
| colspan="2" | Sets the current state of the valve.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0 = Closed, 1 = Open&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>Flip</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''Flip''.
+
==Property reference==
  
−
''<span style="color:red;">No additional information</span>''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Default State
 +
|-
 +
| colspan="2" | The initial state of the valve when the runtime starts&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Current State
 +
|-
 +
| colspan="2" | The current state of the valve.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Orientation
 +
|-
 +
| colspan="2" | The orientation of the valve on the panel.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Clickable
 +
|-
 +
| colspan="2" | Dictates if the valve handle ca be clicked during runtime to open or close the valve,&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Flip
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:13, 7 February 2023

Author Matrix TSL
Version 1.0
Category Industrial


Digital Valve component

A simple digital valve that can be either open or closed. The valve has component macros to set and get the current state of the valve. The valve can be initialised to be open or closed when starting. The valve can be clicked to open or close via the runtime. Compatible with SCADA interconnecting pipe components.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Valve.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Valve.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

GetState

Fc9-comp-macro.png GetState
Returns the current state of the valve. 0 = Closed 1 = Open 
Fc9-bool-icon.png - BOOL Return


SetState

Fc9-comp-macro.png SetState
Sets the current state of the valve. 
Fc9-bool-icon.png - BOOL State
0 = Closed, 1 = Open 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Default State
The initial state of the valve when the runtime starts 
Fc9-type-16-icon.png Current State
The current state of the valve. 
Fc9-type-16-icon.png Orientation
The orientation of the valve on the panel. 
Fc9-type-7-icon.png Clickable
Dictates if the valve handle ca be clicked during runtime to open or close the valve, 
Fc9-type-7-icon.png Flip
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Digital_Valve_(Industrial)&oldid=38407"