Returns a flow value in the requested units based on the head for a given pump

Namespace: configuration_services
Assembly: configuration_services (in configuration_services.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
flow_value get_flow_from_head(
	uint list_id,
	uint pump_state_id,
	head_value input_head,
	DT_FLOW_UNITS flow_unit
)
Visual Basic
Function get_flow_from_head ( _
	list_id As UInteger, _
	pump_state_id As UInteger, _
	input_head As head_value, _
	flow_unit As DT_FLOW_UNITS _
) As flow_value
Visual C++
flow_value^ get_flow_from_head(
	unsigned int list_id, 
	unsigned int pump_state_id, 
	head_value^ input_head, 
	DT_FLOW_UNITS flow_unit
)

Parameters

list_id
Type: System..::..UInt32
The id for the selection list in which the pump resides.
pump_state_id
Type: System..::..UInt32
PumpStateID column from get_list(UInt32) or return value from add_pump(UInt32, Int32, Guid).
input_head
Type: configuration_services..::..head_value
The head value for which the flow is requested
flow_unit
Type: esi.pumps..::..DT_FLOW_UNITS
The requested return units for the flow

Return Value

The flow value corresponding to the input head value in the requested units

See Also