Component: Digital Valve (Industrial): Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/ | 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] | 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== | ==Detailed description== | ||
| Line 36: | Line 38: | ||
==Examples== | ==Examples== | ||
| Line 56: | Line 60: | ||
==Macro reference== | ==Macro reference== | ||
{| 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 | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
{| 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. | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | |||
| width="90%" | State | |||
|- | |||
| colspan="2" | 0 = Closed, 1 = Open | |||
|- | |||
| 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'' | |||
|} | |||
==Property reference== | |||
{| 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 | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | Current State | |||
|- | |||
| colspan="2" | The current state of the valve. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | Orientation | |||
|- | |||
| colspan="2" | The orientation of the valve on the panel. | |||
|- | |||
| 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, | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |||
| width="90%" | Flip | |||
|- | |||
| colspan="2" | | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 10:00, 27 January 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.
Macro reference
|
GetState |
| Returns the current state of the valve. 0 = Closed 1 = Open | |
 - BOOL
|
Return |
|
|
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 |
==Macro reference==
|
|
GetState |
| Returns the current state of the valve. 0 = Closed 1 = Open | |
| - BOOL
|
Return |
|
|
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 |
==Macro reference==
|
|
GetState |
| Returns the current state of the valve. 0 = Closed 1 = Open | |
| - BOOL
|
Return |
|
|
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 |
==Macro reference==
|
|
GetState |
| Returns the current state of the valve. 0 = Closed 1 = Open | |
| - BOOL
|
Return |
|
|
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 |