Core areas:

  • Searching catalogs
  • Enumerating and adding pumps to lists
  • Graphing and changing pumps
  • Reporting

Classes

  ClassDescription
Public classadvanced_criteria
Advanced criteria, all members optional.
Public classarea_value
Dimensional typesafe units.
Public classcatalog_stage
Base for pump_stages who's info comes directly from a pump catalog. Should always be using a subclass of this class. Never use catalog_stage directly. See the diameter_stage class instead.
Public classchange_casing_material
Changes the casing material of a pump.
Public classchange_diameter
Calculates a new trim at the specified diameter. The resulting pump trim will be as close as possible to the requested trim. Warning: triggering a "change_diameter" pump_change for pumps without diameter values will throw an "ArgumentException" exception. Do not use this feature for "label curve" pumps.
Public classchange_impeller_material
Changes the impeller material of a pump.
Public classchange_label
Useful for label curves that that do not generate interpolated trims.
Public classchange_mixed_bowl
Public classchange_motor
Changes the motor associated with a pump and adjusts the baseline curve.
Public classchange_motor_criteria
Changes pump motor selection criteria.
Public classchange_motor_manual
Manually selects a specific motor to pair with the chosen pump. Motor list available via api at pumps_service.get_compatible_pump_motors().
Public classchange_multi_stage
Add or replace user-specified curves for multi-stage pump.
Public classchange_simple_multi_stage
Add or replace user-specified curves for simple multi-stage pump.
Public classchange_speed
Changes the operating speed of this pump.
Public classconfigured_materials
Container class that holds the configured casing material and impeller material of a pump.
Public classconfigured_stages_info
Public classContextManager
Public classcurve_point
Public classdatasheet_rep_settings
Public classdensity_value
Dimensional typesafe units.
Public classdesign_point
Operating point for pump selection.
Public classdiameter_stage
Standard centrifical pump stage. Specify desired impeller curve by diameter. Do not use for pumps with Label Curves, these or other pumps without diameter will throw an "ArgumentException" exception.
Public classfit_speed
Changes the operating speed of this pump to a "best fit" for the design point.
Public classflow_value
Dimensional typesafe units.
Public classfluid_data
Public classgetthumbnail
HTTP endpoint for convienence in supporting browsers that don't support data URI's. Allows end users browsers to call this service and retrieve a thumbnail for display in the selection list. Takes one parameter 'PRID', the value is 'pump_results_ID' found in the DataTable returned from get_list(UInt32). Returns MIME type:image/png
Public classGlobal
Public classhead_value
Dimensional typesafe units.
Public classimpeller_info
Public classlength_value
Dimensional typesafe units.
Public classload_profile
Public classmaterial
A material from which a pump's casing or impeller may be constructed.
Public classmaterial_info
Public classmotor_data_pt
Public classmotor_selection
Information used for motor selection, standard and enclosure specify a particular motor table.
Public classmotor_standard
Public classmotor_standard_list
Public classnpsh_value
Dimensional typesafe units.
Public classoperating_point
Public classoperating_point_data
Public classoptional_criteria
Base class for optional criteria. As new optional criteria are added, additional subclasses may be created. Current code should use optional_criteria_v2 when calling the search function.
Public classoptional_criteria_v2
Optional critiera, all members are independently optional.
Public classoverride_criteria
Settings for overriding the original selection criteria options on subsequent requests to pump results methods.
Public classPilotAuthentication
Public classplev_options
Public classpower_value
Dimensional typesafe units.
Public classpressure_value
Dimensional typesafe units.
Public classpump_change
Base class for several different operations that can be applied to pumps. See change_diameter, change_speed, and change_label. Changes the results from both get_pump(UInt32, UInt32) and get_list(UInt32). Will also impact graphs, reports and may activate warnings.
Public classpump_curve_limits
Public classpump_id_list
Container class used for passing around multiple pump_ids associated with multiple catalogs.
Public classpump_motor
Public classpump_properties
Public classpump_stage
Generic pump_stage, identifies a pump who's curve should be added to a multi-stage pump. Should always be using a subclass of this class. Never use pump_stage directly. See the diameter_stage class instead.
Public classpumpcurve_rep_settings
Public classpumps_v2
Updated pump service supports Localization of notes, warnings, graph images, and reports.
Public classpumpselection
Public classreport_settings
Base class for common report settings see datasheet_rep_settings and pumpcurve_rep_settings.
Public classsize_value
Dimensional typesafe units.
Public classstage_info
Public classtemperature_value
Dimensional typesafe units.
Public classthrustperlen_value
Dimensional typesafe units.
Public classvelocity_value
Dimensional typesafe units.
Public classviscosity_value
Dimensional typesafe units.

Structures

  StructureDescription
Public structurepump_id_list..::..pump_entry

Interfaces

  InterfaceDescription
Public interfaceIfluid
Create and retrieve table and custom fluids.
Public interfacepumps_service Obsolete.
Interaction/interrogation of an individual pump and its operating conditions. Allows changing speeds, impellers, curves. Views allow looking at multiple pump operation, multiple speed operation. Generating PDF reports, and images.
Public interfacepumps_service_v2
Interaction/interrogation of an individual pump and its operating conditions. Allows changing speeds, impellers, curves. Views allow looking at multiple pump operation, multiple speed operation. Generating PDF reports, and images.
Public interfacepumpselection_service
Public interfaceselection_list_service
Operations for creating and adding pumps in selection lists.

Enumerations

  EnumerationDescription
Public enumerationload_profile..::..oppoint_head_from
Overrides default operating point behaviors. unset - ignore this. use defaults specifiedHead - same as default behavior. Use exact head / flow pairs as specied. Reported data for each point is calcuated along the pump's design curve. designCurve - Ignores all specified head values (0 or otherwise) and calculates a head for each flow that intersects the pump's design curve. systemCurve - Ignores all specified head values (0 or otherwise and calculates a head for each flow that intersects the pump's system resistance curve. specifiedHead_speedAdjustCalc - Same as specifiedHead except that reported data for each point is calculated by speed-adjusting the design curve so that it passes through each operating point. systemCurve_speedAdjustCalc - except that reported data for each point is calculated by speed-adjusting the design curve so that it passes through each operating point.
Public enumerationMixedBowlSelection
Public enumerationMixedBowlSizing
Public enumerationmotor_sizing_speed_method
Public enumerationoppoint_head_from
Overrides default operating point behaviors. unset - ignore this. use defaults specifiedHead - same as default behavior. Use exact head / flow pairs as specied. Reported data for each point is calcuated along the pump's design curve. designCurve - Ignores all specified head values (0 or otherwise) and calculates a head for each flow that intersects the pump's design curve. systemCurve - Ignores all specified head values (0 or otherwise and calculates a head for each flow that intersects the pump's system resistance curve. specifiedHead_speedAdjustCalc - Same as specifiedHead except that reported data for each point is calculated by speed-adjusting the design curve so that it passes through each operating point. systemCurve_speedAdjustCalc - except that reported data for each point is calculated by speed-adjusting the design curve so that it passes through each operating point.
Public enumerationunit_system