Valve Control and Status
Overview
This groups defines all functions for control of valves and for reading valve status.
Collaboration diagram for Valve Control and Status:
Functions | |
| long | LCV_ActualValvePosition (dev_hdl hValve) |
| Returns the actual logical valve position. More... | |
| long | LCV_NumberOfValvePositions (dev_hdl hValve) |
| Returns the number of valve positions. More... | |
| long | LCV_SwitchValveToPosition (dev_hdl hValve, int LogicalValvePosition) |
| Switches the valve to a certain logical valve position. More... | |
Function Documentation
| long LCV_ActualValvePosition | ( | dev_hdl | hValve | ) |
Returns the actual logical valve position.
Each valve position is identified by a logical valve position identifier from 0 - number of valve positions - 1. This function returns the logical valve position identifier for the current valve position.
- Parameters
-
[in] hValve Valid valve handle
- Return values
-
>=0 Actual valve position index. <0 Error code
- See also
- LCV_SwitchValveToPosition()
- Examples:
- capi_nemesys4_test.cpp, capi_nemesys_test.cpp, and capi_nemesys_valve_test.cpp.
| long LCV_NumberOfValvePositions | ( | dev_hdl | hValve | ) |
Returns the number of valve positions.
Each valve has a number of available valve positions. I.e. a switching valve has two positions or a rotation valve can have 4 or even more positions.
- Parameters
-
[in] hValve Valid valve handle
- Return values
-
>0 Number of valve positions <=0 Error code
- Examples:
- capi_nemesys4_test.cpp, capi_nemesys_test.cpp, and capi_nemesys_valve_test.cpp.
| long LCV_SwitchValveToPosition | ( | dev_hdl | hValve, |
| int | LogicalValvePosition | ||
| ) |
Switches the valve to a certain logical valve position.
- Note
- For some devices, like rotation valves, it may last some hundred milliseconds until device reached its final position.
- Parameters
-
[in] hValve Valid valve handle [in] LogicalValvePosition Logical valve target position index.
- Return values
-
ERR_NOERR indicates success
- See also
- LCV_ActualValvePosition();
- Examples:
- capi_nemesys4_test.cpp, capi_nemesys_test.cpp, and capi_nemesys_valve_test.cpp.