pywfm.misc.IWFMMiscellaneous

class pywfm.misc.IWFMMiscellaneous

IWFM Miscellaneous Class for interacting with the IWFM API

Returns:

instance of the IWFMMiscellaneous class and access to the IWFM Miscellaneous fortran procedures.

Return type:

IWFMMiscellaneous Object

Note

This class is a base class and is not meant to be called directly. It is not provided with an __init__ method, so the self.dll used in each of the methods must be provided through the subclass.

__init__()

Methods

__init__()
close_log_file()
get_budget_type_ids()
get_data_unit_type_id_area()
get_data_unit_type_id_length()
get_data_unit_type_ids()
get_data_unit_type_volume()
get_flow_destination_type_id()
get_flow_destination_type_id_element()
get_flow_destination_type_id_elementset()
get_flow_destination_type_id_gwelement()
get_flow_destination_type_id_lake()
get_flow_destination_type_id_outside()
get_flow_destination_type_id_streamnode()
get_flow_destination_type_id_subregion()
get_land_use_type_id_gen_ag()
get_land_use_type_id_native_riparian()
get_land_use_type_id_nonponded_ag()
get_land_use_type_id_refuge()
get_land_use_type_id_rice()
get_land_use_type_id_urban()
get_land_use_type_id_urban_indoor()
get_land_use_type_id_urban_outdoor()
get_land_use_type_ids()
get_land_use_type_ids_1()
get_last_message()	the error message in case a procedure call from IWFM API returns an error code (status) other than 0
get_location_type_id_bypass()
get_location_type_id_diversion()
get_location_type_id_element()
get_location_type_id_gwheadobs()
get_location_type_id_lake()
get_location_type_id_node()
get_location_type_id_smallwatershed()
get_location_type_id_streamhydobs()
get_location_type_id_streamnode()
get_location_type_id_streamnodebud()
get_location_type_id_streamreach()
get_location_type_id_subregion()
get_location_type_id_subsidenceobs()
get_location_type_id_tiledrainobs()
get_location_type_id_zone()
get_location_type_ids()
get_location_type_ids_1()
get_n_intervals(begin_date, end_date, ...[, ...])	returns the number of time intervals between a provided start date and end date
get_supply_type_id_diversion()
get_supply_type_id_elempump()
get_supply_type_id_well()
get_version()	returns the version of the IWFM DLL
get_zbudget_type_ids()
get_zone_extent_id_horizontal()
get_zone_extent_id_vertical()
get_zone_extent_ids()
increment_time(date_string, time_interval, ...)	increments the date provided by the specified time interval
is_date_greater(first_date, comparison_date)	returns True if first_date is greater than comparison_date
log_last_message()	prints the last error message (generated when a procedure call from IWFM API returns an error code (status) other than 0) to the message log file
set_log_file([file_name])	opens a text log file to print out error and warning messages