ItemValve
- Last UpdatedDec 16, 2023
- 4 minute read
The ItemValve node is used to map manual valves.
-
It supports manual valves with either handwheel or handle.
-
It supports valves with or without stem.
-
The ItemValve node inherits from Item.
Platform support
This node is fully supported on XR-Windows platform.
It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Partial support |
Partial support |
Partial support |
Partial support |
|
|
|
|
|
|
Mode
The ItemValve has the following modes.
|
Mode |
Description |
|---|---|
|
Local |
In local mode, the valve is completely operated by engine logic. The valve movement is driven by the internally set operation. Even if set as local, the valve still reacts to value settings from outside. |
|
Bridged |
In bridged mode, value movement is driven from the outside. When the user requests to open or close the valve, the desired operation is sent to a remote system (process simulator) and this system sets the value according to the requested operation. This mode can experience delay. |
|
Auto |
In auto mode, when a valve is set in auto mode, it operates as local until it receives at least one value from the outside. From that point on, it works as bridged. |
Engage setting for automatic
Some valves can use the hand-wheel only as an override of another automatic drive, such as motor or pressurized air.
In these cases, the hand-wheel must not turn when the valve is driven automatically.
This behavior can be achieved by setting the Engage parameter to false.
Engage setting for manual
When operating the valve manually, the Engage parameter must be set to true.
Note: The open, close, and set operations actions do not work for a disengaged valve.
Code example
This is a code example for the ItemValve node.
<ItemValve name="V52001" />
Default Actions
|
Action |
Hotkey |
Text |
Description |
|---|---|---|---|
|
Open |
RT |
Open |
Increments op forcing valve to move to open state. |
|
Close |
LT |
Close |
Decrements op forcing valve to move to close state. |
|
Check |
Check |
Checks valve state. |
|
|
Setop |
Set Op |
Enables you to directly set a particular op. |
ItemValve fields
These are the fields for ItemValve node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > NodeBaseMovable > Item > ItemValve
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
chainSpeed |
sfloat |
Optional |
1 |
Defines the valve chain turning speed in radiant/sec. |
|
engage |
sbool |
Optional |
true |
When set to false, the hand-wheel position is not linked to value. The open, close, and set-op actions do not work. |
|
handleMesh |
sstring |
Optional |
Auto-populated |
Name of the valve handle mesh. Can be overridden if the item does not support naming convention. |
|
invertRotation |
sbool |
Optional |
false |
Inverts the sense of rotation of the valve. |
|
mode |
senum |
Optional |
Auto |
Specifies valve behavior: Bridged, Local, or Auto. |
|
op |
sfloat |
Optional |
Not set |
The target valve opening value. |
|
range |
sfloat |
Optional |
0 1 |
Reduces the possible OP range. |
|
rotationSpeed |
sfloat |
Optional |
1 |
Speed (in % / second) to open or close the valve. Example: 0.1 means ten seconds to move from 0 to 1. |
|
statesHandle |
mfloat |
Optional |
0,6.28 |
Defines the closed and opened offset angles of the handle in radiants. If more than one turn is needed, use multiple of 6.28. |
|
statesStem |
mfloat |
Optional |
0,0.1 |
Defines the closed and opened offset positions of the stem. |
|
stemMesh |
sstring |
Optional |
Auto-populated |
Name of the valve stem mesh. Can be overridden if the item does not support naming convention. |
|
value |
sfloat |
Optional |
0 |
Represents the current state of the valve (0 closed - 1 open). In other systems, this parameter is called pos. |