IWFMMiscellaneous

API Version

get_version()

returns the version of the IWFM DLL

Time-Related

get_n_intervals(begin_date, end_date, ...[, ...])	returns the number of time intervals between a provided start date and end date
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

Logging Messages

get_last_message()	the error message in case a procedure call from IWFM API returns an error code (status) other than 0
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
close_log_file()

IWFM-Internal

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_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_supply_type_id_diversion()
get_supply_type_id_elempump()
get_supply_type_id_well()
get_zbudget_type_ids()
get_zone_extent_id_horizontal()
get_zone_extent_id_vertical()
get_zone_extent_ids()
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()

Private Methods

_is_time_interval_greater_or_equal(...)	determines if a provided time_interval is greater than or equal to the simulation_time_interval
_string_to_list_by_array(in_string, ...)	converts a string to a list of strings based on an array of the starting character position (index).
_validate_iwfm_date(dt)	performs validation that a provided value is an IWFM-format date string based on string length and format MM/DD/YYYY_HH:MM
_validate_time_interval(time_interval)	performs validation that a provided value is an IWFM-format time-interval string