Jump to content

Component: Digital Valve (Industrial): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
XML import
 
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(16 intermediate revisions by 3 users 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.
''No detailed description exists yet for this component''
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==
==Examples==
''<span style="color:red;">No additional examples</span>''




==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


===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}}








==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''.
==Macro reference==


The orientation of the valve on the panel.
===GetState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


<span style="font-weight: normal;"><u>Clickable</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''Clickable''.
===SetState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


Dictates if the valve handle ca be clicked during runtime to open or close the valve,


<span style="font-weight: normal;"><u>Flip</u></span>
==Property reference==


This property is of type ''True or false'' and can be referenced with the variable name ''Flip''.
{| class="mtx-class-macrotable wikitable"
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''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 14:22, 13 July 2026

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.

Industrial Tanks






Macro reference

GetState

GetState
Returns the current state of the valve. 0 = Closed 1 = Open 
- BOOL Return


SetState

SetState
Sets the current state of the valve. 
- BOOL State
0 = Closed, 1 = Open 
- VOID Return


Property reference

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