Innovyze-ICM-Libraries
Innovyze-ICM-Libraries copied to clipboard
sancarn
Various Methods are undocumented.
There are various methods which are undocumented. Let's fix this as best as we can.
Note: Class.method = Static method Class.instance.method = Instance method
List of undocumented methods (in ICM 6.5.6):
WSApplication.compare_binary_results_files
WSApplication.delete_temp_files?
WSApplication.delete_temp_files=
WSApplication.local_root
WSApplication.log_event
WSApplication.override_user_unit
WSApplication.override_working_folder
WSApplication.set_local_root
WSApplication.use_user_units
WSApplication.post_debug
WSApplication.use_arcgis_desktop_licence
WSApplication.cancel_job
WSApplication.input_box
WSDatabase.instance.custom_schema
WSDatabase.instance.scripting_name_of_type
WSModelObject.instance.compare_results_to_file
WSModelObject.instance.compare_to_csv
WSModelObject.instance.csv_import_tvd
WSModelObject.instance.duplicate_model_object
WSModelObject.instance.find_child_object
WSModelObject.instance.import_grid_ground_model
WSModelObject.instance.import_layer_list
WSModelObject.instance.import_tvd
WSModelObject.instance.new_model_object
WSModelObject.instance.new_risk_analysis_run
WSModelObject.instance.new_synthetic_rainfall
WSModelObject.instance.open_version
WSModelObject.instance.tvd_unit_type
WSModelObject.instance.tvd_unit_type=
WSModelObject.instance.update_dashboard
WSNumbatNetworkObject.instance.befdss_export
WSNumbatNetworkObject.instance.befdss_import_cctv
WSNumbatNetworkObject.instance.befdss_import_manhole_surveys
WSNumbatNetworkObject.instance.cctv_standard
WSNumbatNetworkObject.instance.choices
WSNumbatNetworkObject.instance.csv_changes_inm
WSNumbatNetworkObject.instance.field_choices
WSNumbatNetworkObject.instance.field_choice_descriptions
WSNumbatNetworkObject.instance.get_projection_string
WSNumbatNetworkObject.instance.get_projection_bounds
WSNumbatNetworkObject.instance.mhsurvey_standard
WSNumbatNetworkObject.instance.odic_import
WSNumbatNetworkObject.instance.odec_export
WSNumbatNetworkObject.instance.[]
WSNumbatNetworkObject.instance.[]=
WSNumbatNetworkObject.instance.bulk_delete
WSNumbatNetworkObject.instance.children
WSNumbatNetworkObject.instance.comment
WSNumbatNetworkObject.instance.comment=
WSNumbatNetworkObject.instance.compare
WSNumbatNetworkObject.instance.compare_results_to_file
WSNumbatNetworkObject.instance.compare_to_csv
WSNumbatNetworkObject.instance.copy_here
WSNumbatNetworkObject.instance.csv_import_tvd
WSNumbatNetworkObject.instance.deletable?
WSNumbatNetworkObject.instance.delete
WSNumbatNetworkObject.instance.delete_results
WSNumbatNetworkObject.instance.duplicate_model_object
WSNumbatNetworkObject.instance.export
WSNumbatNetworkObject.instance.find_child_object
WSNumbatNetworkObject.instance.find_child_model_object
WSNumbatNetworkObject.instance.id
WSNumbatNetworkObject.instance.import_data
WSNumbatNetworkObject.instance.import_new_model_object
WSNumbatNetworkObject.instance.import_grid_ground_model
WSNumbatNetworkObject.instance.import_layer_list
WSNumbatNetworkObject.instance.import_tvd
WSNumbatNetworkObject.instance.modified_by
WSNumbatNetworkObject.instance.name=
WSNumbatNetworkObject.instance.new_model_object
WSNumbatNetworkObject.instance.new_run
WSNumbatNetworkObject.instance.new_risk_analysis_run
WSNumbatNetworkObject.instance.new_synthetic_rainfall
WSNumbatNetworkObject.instance.open
WSNumbatNetworkObject.instance.open_version
WSNumbatNetworkObject.instance.parent_type
WSNumbatNetworkObject.instance.parent_id
WSNumbatNetworkObject.instance.path
WSNumbatNetworkObject.instance.tvd_unit_type
WSNumbatNetworkObject.instance.tvd_unit_type=
WSNumbatNetworkObject.instance.type
WSNumbatNetworkObject.instance.update_dashboard
WSNumbatNetworkObject.instance.update_to_latest
WSSimObject.instance.results_path
WSSimObject.instance.single_result_csv_export
WSSimObject.instance.bodge_for_Mark
WSSimObject.instance.[]
WSSimObject.instance.[]=
WSSimObject.instance.bulk_delete
WSSimObject.instance.children
WSSimObject.instance.comment
WSSimObject.instance.comment=
WSSimObject.instance.compare
WSSimObject.instance.compare_results_to_file
WSSimObject.instance.compare_to_csv
WSSimObject.instance.copy_here
WSSimObject.instance.csv_import_tvd
WSSimObject.instance.deletable?
WSSimObject.instance.delete
WSSimObject.instance.delete_results
WSSimObject.instance.duplicate_model_object
WSSimObject.instance.export
WSSimObject.instance.find_child_object
WSSimObject.instance.find_child_model_object
WSSimObject.instance.id
WSSimObject.instance.import_data
WSSimObject.instance.import_new_model_object
WSSimObject.instance.import_grid_ground_model
WSSimObject.instance.import_layer_list
WSSimObject.instance.import_tvd
WSSimObject.instance.modified_by
WSSimObject.instance.name=
WSSimObject.instance.new_model_object
WSSimObject.instance.new_run
WSSimObject.instance.new_risk_analysis_run
WSSimObject.instance.new_synthetic_rainfall
WSSimObject.instance.open
WSSimObject.instance.open_version
WSSimObject.instance.parent_type
WSSimObject.instance.parent_id
WSSimObject.instance.path
WSSimObject.instance.tvd_unit_type
WSSimObject.instance.tvd_unit_type=
WSSimObject.instance.type
WSSimObject.instance.update_dashboard
WSSimObject.instance.update_to_latest
WSRiskAnalysisRunObject.instance.run_ex
WSRiskAnalysisRunObject.instance.[]
WSRiskAnalysisRunObject.instance.[]=
WSRiskAnalysisRunObject.instance.bulk_delete
WSRiskAnalysisRunObject.instance.children
WSRiskAnalysisRunObject.instance.comment
WSRiskAnalysisRunObject.instance.comment=
WSRiskAnalysisRunObject.instance.compare
WSRiskAnalysisRunObject.instance.compare_results_to_file
WSRiskAnalysisRunObject.instance.compare_to_csv
WSRiskAnalysisRunObject.instance.copy_here
WSRiskAnalysisRunObject.instance.csv_import_tvd
WSRiskAnalysisRunObject.instance.deletable?
WSRiskAnalysisRunObject.instance.delete
WSRiskAnalysisRunObject.instance.delete_results
WSRiskAnalysisRunObject.instance.duplicate_model_object
WSRiskAnalysisRunObject.instance.export
WSRiskAnalysisRunObject.instance.find_child_object
WSRiskAnalysisRunObject.instance.find_child_model_object
WSRiskAnalysisRunObject.instance.id
WSRiskAnalysisRunObject.instance.import_data
WSRiskAnalysisRunObject.instance.import_new_model_object
WSRiskAnalysisRunObject.instance.import_grid_ground_model
WSRiskAnalysisRunObject.instance.import_layer_list
WSRiskAnalysisRunObject.instance.import_tvd
WSRiskAnalysisRunObject.instance.modified_by
WSRiskAnalysisRunObject.instance.name=
WSRiskAnalysisRunObject.instance.new_model_object
WSRiskAnalysisRunObject.instance.new_run
WSRiskAnalysisRunObject.instance.new_risk_analysis_run
WSRiskAnalysisRunObject.instance.new_synthetic_rainfall
WSRiskAnalysisRunObject.instance.open
WSRiskAnalysisRunObject.instance.open_version
WSRiskAnalysisRunObject.instance.parent_type
WSRiskAnalysisRunObject.instance.parent_id
WSRiskAnalysisRunObject.instance.path
WSRiskAnalysisRunObject.instance.tvd_unit_type
WSRiskAnalysisRunObject.instance.tvd_unit_type=
WSRiskAnalysisRunObject.instance.type
WSRiskAnalysisRunObject.instance.update_dashboard
WSRiskAnalysisRunObject.instance.update_to_latest
WSOpenNetwork.instance.befdss_export
WSOpenNetwork.instance.befdss_import_cctv
WSOpenNetwork.instance.befdss_import_manhole_surveys
WSOpenNetwork.instance.cctv_standard
WSOpenNetwork.instance.clear_selection
WSOpenNetwork.instance.commit_bypassing_validation
WSOpenNetwork.instance.csv_export
WSOpenNetwork.instance.field_choices
WSOpenNetwork.instance.field_choice_descriptions
WSOpenNetwork.instance.field_names
WSOpenNetwork.instance.get_projection_string
WSOpenNetwork.instance.get_projection_bounds
WSOpenNetwork.instance.get_string_pref
WSOpenNetwork.instance.geometry_mbr
WSOpenNetwork.instance.intersect
WSOpenNetwork.instance.mhsurvey_standard
WSOpenNetwork.instance.odic_import
WSOpenNetwork.instance.odec_export
WSOpenNetwork.instance.open_mo_layer_list
WSOpenNetwork.instance.put_string_pref
WSOpenNetwork.instance.search_at_point
WSOpenNetwork.instance.thin_and_clean_polygons
WSOpenNetwork.instance.update_cctv_scores_std
WSOpenNetwork.instance.commit
WSOpenNetwork.instance.revert
WSRowObject.instance.autoname
WSRowObject.instance.selected
WSRowObject.instance.method_missing
WSNode.instance.[]
WSNode.instance.[]=
WSNode.instance.autoname
WSNode.instance.category
WSNode.instance.contains?
WSNode.instance.delete
WSNode.instance.field
WSNode.instance.id
WSNode.instance.id=
WSNode.instance.is_inside?
WSNode.instance.navigate
WSNode.instance.navigate1
WSNode.instance.objects_in_polygon
WSNode.instance.selected
WSNode.instance.selected?
WSNode.instance.selected=
WSNode.instance.table
WSNode.instance.table_info
WSNode.instance.write
WSNode.instance.method_missing
WSLink.instance.[]
WSLink.instance.[]=
WSLink.instance.autoname
WSLink.instance.category
WSLink.instance.contains?
WSLink.instance.delete
WSLink.instance.field
WSLink.instance.id
WSLink.instance.id=
WSLink.instance.is_inside?
WSLink.instance.navigate
WSLink.instance.navigate1
WSLink.instance.objects_in_polygon
WSLink.instance.selected
WSLink.instance.selected?
WSLink.instance.selected=
WSLink.instance.table
WSLink.instance.table_info
WSLink.instance.write
WSLink.instance.method_missing
WSStructureRow.instance.method_missing
WSCommits.instance.each
WSCommits.instance.length
WSCommits.instance.[]
WSCommit.instance.branch_id
WSCommit.instance.comment
WSCommit.instance.commit_id
WSCommit.instance.date
WSCommit.instance.deleted_count
WSCommit.instance.inserted_count
WSCommit.instance.modified_count
WSCommit.instance.setting_changed_count
WSCommit.instance.user
WSIntersect2.instance.csv_in
WSIntersect2.instance.csv_out
WSIntersect2.instance.html_logger
WSIntersect2.instance.csv_load_failed_polylines
WSIntersect2.instance.csv_load_failed_polygons
WSIntersect2.instance.csv_load_ignored_holes
WSIntersect2.instance.xml_debug_intersection
WSIntersect2.instance.xml_intersection_state
WSIntersect2.instance.thinning
WSIntersect2.instance.range_restriction
WSIntersect2.instance.cycle_face_id_containment
WSIntersect2.instance.modify
WSIntersect2.instance.compare
WSIntersect2.instance.mask_get_point
WSIntersect2.instance.mask_get_polyline
WSIntersect2.instance.mask_get_polygon
WSIntersect2.instance.do_it
WSIntersect2.instance.set_lds
WSIntersect2.instance.polygon_category
WSIntersect2.instance.debug_on
WSIntersect2.instance.create_polygons
WSIntersect2.instance.log_load_statistics
WSIntersect2.instance.log_points
WSIntersect2.instance.log_polylines
WSIntersect2.instance.log_polygons
WSPolygon.instance.add_attribute
WSPolygon.instance.area
WSPolygon.instance.bounds
WSPolygon.instance.count_attribute_sets
WSPolygon.instance.get_attribute
WSPolygon.instance.ids
WSPolygon.instance.id_coords
WSPolygon.instance.is_valid
WSPolygon.instance.valid?
WSPolygon.instance.push_back
WSPolygon.instance.reserve
WSPolygon.instance.to_xml
WSIWPolygon.instance.set_coords_and_area
WSIWPolygon.instance.[]
WSIWPolygon.instance.[]=
WSIWPolygon.instance.autoname
WSIWPolygon.instance.category
WSIWPolygon.instance.contains?
WSIWPolygon.instance.delete
WSIWPolygon.instance.field
WSIWPolygon.instance.id
WSIWPolygon.instance.id=
WSIWPolygon.instance.is_inside?
WSIWPolygon.instance.navigate
WSIWPolygon.instance.navigate1
WSIWPolygon.instance.objects_in_polygon
WSIWPolygon.instance.selected
WSIWPolygon.instance.selected?
WSIWPolygon.instance.selected=
WSIWPolygon.instance.table
WSIWPolygon.instance.table_info
WSIWPolygon.instance.write
WSIWPolygon.instance.method_missing
WSBounds.instance.clear
WSBounds.instance.add_coord
WSBounds.instance.add_bounds
WSBounds.instance.set
WSBounds.instance.valid
WSBounds.instance.valid?
WSBounds.instance.inside
WSBounds.instance.overlap
WSBounds.instance.xmin
WSBounds.instance.xmax
WSBounds.instance.ymin
WSBounds.instance.ymax
WSBounds.instance.cx
WSBounds.instance.cy
WSBounds.instance.dx
WSBounds.instance.dy
WSBounds.instance.inflate
WSNetSelectionList.instance.count
WSNetSelectionList.instance.from_row_objects
WSNetSelectionList.instance.group_count
WSNetSelectionList.instance.group_description
WSNetSelectionList.instance.group_type
WSNetSelectionList.instance.load_from_network
WSNetSelectionList.instance.make_selections_in_network
WSNetSelectionList.instance.save_to_selection_mo
WSNetSelectionList.instance.to_row_objects
WSSpatialBookmarks.instance.set_bookmark
WSSpatialBookmarks.instance.new_bookmark_from_selection
WSSpatialBookmarks.instance.delete_bookmark
WSSpatialBookmarks.instance.set_bookmark_bounds
WSSpatialBookmarks.instance.get_bookmark
WSSpatialBookmarks.instance.load_from_network
WSSpatialBookmarks.instance.save_to_network
WSSpatialBookmarks.instance.load_from_file
WSSpatialBookmarks.instance.save_to_file
WSDongleCheck.ICM_and_InfoNet_method
WSDongleCheck.ICM_method
WSDongleCheck.InfoNet_method
WSDongleCheck.dep_method
WSDongleCheck.internal_method
Edit: List may be incomplete. I've already found that WSModelObject.instance.parent_type and WSModelObject.instance.parent_id are missing from the above list.
Playing around with undocumented spatial bookmarks:
spat = WSSpatialBookmarks.new
#spat.new_bookmark_from_selection "",_.net,1,1 #< freeze (perhaps first parameter is name of spatial bookmark?
spat.new_bookmark_from_selection "abc",_.net,1,1 #< works?
spat.save_to_network _.net #< works!
A more detailed list of functions including number of parameters and class names (to avoid confusion) can be found below:
req = required parameter
rest = parameter array / remaining parameters
opt = optional parameters
block = blocks (these do not appear to be shown by Method#parameters (possibly due to C add-on?)
Class.method = Static method
Class.instance.method = Instance method
The following was an export from the version of ICM I use (v6.5.6).
WSApplication.add_ons_folder ()
WSApplication.compare_binary_results_files (req, req, req, req)
WSApplication.create (req)
WSApplication.create_transportable (req)
WSApplication.delete_temp_files? ()
WSApplication.delete_temp_files= (req)
WSApplication.local_root ()
WSApplication.working_folder ()
WSApplication.results_folder ()
WSApplication.log_event (req, req)
WSApplication.open (req, req)
WSApplication.override_user_unit (req, req)
WSApplication.override_user_units (req)
WSApplication.override_working_folder (req)
WSApplication.script_file ()
WSApplication.set_exit_code (req)
WSApplication.set_local_root (req)
WSApplication.set_working_folder (req)
WSApplication.set_results_folder (req)
WSApplication.use_user_units ()
WSApplication.use_user_units? ()
WSApplication.use_user_units= (req)
WSApplication.version ()
WSApplication.post_debug (req)
WSApplication.connect_local_agent (req)
WSApplication.launch_sims (req, req, req, req, req)
WSApplication.use_arcgis_desktop_licence ()
WSApplication.wait_for_jobs (req, req, req)
WSApplication.cancel_job (req)
WSApplication.background_network ()
WSApplication.current_database ()
WSApplication.current_network ()
WSApplication.file_dialog (req, req, req, req, req, req)
WSApplication.folder_dialog (req, req)
WSApplication.input_box (req, req, req)
WSApplication.ui? ()
WSApplication.message_box (req, req, req, req)
WSApplication.open_text_view (req, req, req)
WSApplication.prompt (req, req, req)
WSApplication.scalars (req, req, req)
WSDatabase.instance.copy_into_root (req, req, req)
WSDatabase.instance.custom_schema (req)
WSDatabase.instance.file_root ()
WSDatabase.instance.find_model_object (req, req)
WSDatabase.instance.find_root_model_object (req, req)
WSDatabase.instance.guid ()
WSDatabase.instance.list_read_write_run_fields ()
WSDatabase.instance.model_object (req)
WSDatabase.instance.model_object_collection (req)
WSDatabase.instance.model_object_from_type_and_guid (req, req)
WSDatabase.instance.model_object_from_type_and_id (req, req)
WSDatabase.instance.new_network_name (req, req, req, req)
WSDatabase.instance.scripting_name_of_type (req)
WSDatabase.instance.new_model_object (req, req)
WSDatabase.instance.path ()
WSDatabase.instance.root_model_objects ()
WSModelObject.instance.[] (req)
WSModelObject.instance.[]= (req, req)
WSModelObject.instance.bulk_delete ()
WSModelObject.instance.children ()
WSModelObject.instance.comment ()
WSModelObject.instance.comment= (req)
WSModelObject.instance.compare (req)
WSModelObject.instance.compare_results_to_file (req, req, req)
WSModelObject.instance.compare_to_csv (req, req, req)
WSModelObject.instance.copy_here (req, req, req)
WSModelObject.instance.csv_import_tvd (req, req, req)
WSModelObject.instance.deletable? ()
WSModelObject.instance.delete ()
WSModelObject.instance.delete_results ()
WSModelObject.instance.duplicate_model_object (req)
WSModelObject.instance.export (req, req)
WSModelObject.instance.find_child_object (req, req)
WSModelObject.instance.find_child_model_object (req, req)
WSModelObject.instance.id ()
WSModelObject.instance.import_data (req, req)
WSModelObject.instance.import_new_model_object (req, req, req, req, req)
WSModelObject.instance.import_grid_ground_model (req, req, req)
WSModelObject.instance.import_layer_list (req, req)
WSModelObject.instance.import_tvd (req, req, req)
WSModelObject.instance.modified_by ()
WSModelObject.instance.name= (req)
WSModelObject.instance.new_model_object (req, req)
WSModelObject.instance.new_run (req, req, req, req, req, req)
WSModelObject.instance.new_risk_analysis_run (req, req, req, req)
WSModelObject.instance.new_synthetic_rainfall (req, req, req)
WSModelObject.instance.open ()
WSModelObject.instance.open_version (req)
WSModelObject.instance.parent_type ()
WSModelObject.instance.parent_id ()
WSModelObject.instance.path ()
WSModelObject.instance.tvd_unit_type ()
WSModelObject.instance.tvd_unit_type= (req)
WSModelObject.instance.type ()
WSModelObject.instance.update_dashboard ()
WSModelObject.instance.update_to_latest ()
WSNumbatNetworkObject.instance.befdss_export (req, req, req, req, req)
WSNumbatNetworkObject.instance.befdss_import_cctv (req, req, req, req, req, req, req)
WSNumbatNetworkObject.instance.befdss_import_manhole_surveys(req, req, req, req, req, req, req)
WSNumbatNetworkObject.instance.cctv_standard ()
WSNumbatNetworkObject.instance.choices (req, req)
WSNumbatNetworkObject.instance.commit (req)
WSNumbatNetworkObject.instance.commits ()
WSNumbatNetworkObject.instance.commit_reserve (req)
WSNumbatNetworkObject.instance.csv_changes (req, req, req)
WSNumbatNetworkObject.instance.csv_changes_inm (req, req, req)
WSNumbatNetworkObject.instance.csv_export (req, req)
WSNumbatNetworkObject.instance.csv_import (req, req)
WSNumbatNetworkObject.instance.current_commit_id ()
WSNumbatNetworkObject.instance.field_choices (req, req)
WSNumbatNetworkObject.instance.field_choice_descriptions (req, req)
WSNumbatNetworkObject.instance.get_projection_string (req)
WSNumbatNetworkObject.instance.get_projection_bounds (req)
WSNumbatNetworkObject.instance.latest_commit_id ()
WSNumbatNetworkObject.instance.mhsurvey_standard ()
WSNumbatNetworkObject.instance.odic_import (rest)
WSNumbatNetworkObject.instance.odic_import_ex (rest)
WSNumbatNetworkObject.instance.odec_export (rest)
WSNumbatNetworkObject.instance.odec_export_ex (rest)
WSNumbatNetworkObject.instance.remove_local ()
WSNumbatNetworkObject.instance.reserve ()
WSNumbatNetworkObject.instance.revert ()
WSNumbatNetworkObject.instance.select_sql (req, req)
WSNumbatNetworkObject.instance.select_clear ()
WSNumbatNetworkObject.instance.select_count ()
WSNumbatNetworkObject.instance.select_changes (req)
WSNumbatNetworkObject.instance.uncommitted_changes? ()
WSNumbatNetworkObject.instance.unreserve ()
WSNumbatNetworkObject.instance.update ()
WSNumbatNetworkObject.instance.user_field_names (req, req)
WSNumbatNetworkObject.instance.[] (req)
WSNumbatNetworkObject.instance.[]= (req, req)
WSNumbatNetworkObject.instance.bulk_delete ()
WSNumbatNetworkObject.instance.children ()
WSNumbatNetworkObject.instance.comment ()
WSNumbatNetworkObject.instance.comment= (req)
WSNumbatNetworkObject.instance.compare (req)
WSNumbatNetworkObject.instance.compare_results_to_file (req, req, req)
WSNumbatNetworkObject.instance.compare_to_csv (req, req, req)
WSNumbatNetworkObject.instance.copy_here (req, req, req)
WSNumbatNetworkObject.instance.csv_import_tvd (req, req, req)
WSNumbatNetworkObject.instance.deletable? ()
WSNumbatNetworkObject.instance.delete ()
WSNumbatNetworkObject.instance.delete_results ()
WSNumbatNetworkObject.instance.duplicate_model_object (req)
WSNumbatNetworkObject.instance.export (req, req)
WSNumbatNetworkObject.instance.find_child_object (req, req)
WSNumbatNetworkObject.instance.find_child_model_object (req, req)
WSNumbatNetworkObject.instance.id ()
WSNumbatNetworkObject.instance.import_data (req, req)
WSNumbatNetworkObject.instance.import_new_model_object (req, req, req, req, req)
WSNumbatNetworkObject.instance.import_grid_ground_model (req, req, req)
WSNumbatNetworkObject.instance.import_layer_list (req, req)
WSNumbatNetworkObject.instance.import_tvd (req, req, req)
WSNumbatNetworkObject.instance.modified_by ()
WSNumbatNetworkObject.instance.name= (req)
WSNumbatNetworkObject.instance.new_model_object (req, req)
WSNumbatNetworkObject.instance.new_run (req, req, req, req, req, req)
WSNumbatNetworkObject.instance.new_risk_analysis_run (req, req, req, req)
WSNumbatNetworkObject.instance.new_synthetic_rainfall (req, req, req)
WSNumbatNetworkObject.instance.open ()
WSNumbatNetworkObject.instance.open_version (req)
WSNumbatNetworkObject.instance.parent_type ()
WSNumbatNetworkObject.instance.parent_id ()
WSNumbatNetworkObject.instance.path ()
WSNumbatNetworkObject.instance.tvd_unit_type ()
WSNumbatNetworkObject.instance.tvd_unit_type= (req)
WSNumbatNetworkObject.instance.type ()
WSNumbatNetworkObject.instance.update_dashboard ()
WSNumbatNetworkObject.instance.update_to_latest ()
WSSimObject.instance.list_max_results_attributes ()
WSSimObject.instance.list_results_attributes ()
WSSimObject.instance.list_results_GIS_export_tables ()
WSSimObject.instance.list_timesteps ()
WSSimObject.instance.max_results_binary_export (req, req, req)
WSSimObject.instance.max_results_csv_export (req, req, req)
WSSimObject.instance.results_binary_export (req, req, req)
WSSimObject.instance.results_csv_export (req, req)
WSSimObject.instance.results_csv_export_ex (req, req, req)
WSSimObject.instance.results_GIS_export (req, req, req, req)
WSSimObject.instance.results_path ()
WSSimObject.instance.run ()
WSSimObject.instance.run_ex (req, req)
WSSimObject.instance.status ()
WSSimObject.instance.success_substatus ()
WSSimObject.instance.single_result_csv_export (req, req, req, req)
WSSimObject.instance.timestep_count ()
WSSimObject.instance.bodge_for_Mark (req, req)
WSSimObject.instance.[] (req)
WSSimObject.instance.[]= (req, req)
WSSimObject.instance.bulk_delete ()
WSSimObject.instance.children ()
WSSimObject.instance.comment ()
WSSimObject.instance.comment= (req)
WSSimObject.instance.compare (req)
WSSimObject.instance.compare_results_to_file (req, req, req)
WSSimObject.instance.compare_to_csv (req, req, req)
WSSimObject.instance.copy_here (req, req, req)
WSSimObject.instance.csv_import_tvd (req, req, req)
WSSimObject.instance.deletable? ()
WSSimObject.instance.delete ()
WSSimObject.instance.delete_results ()
WSSimObject.instance.duplicate_model_object (req)
WSSimObject.instance.export (req, req)
WSSimObject.instance.find_child_object (req, req)
WSSimObject.instance.find_child_model_object (req, req)
WSSimObject.instance.id ()
WSSimObject.instance.import_data (req, req)
WSSimObject.instance.import_new_model_object (req, req, req, req, req)
WSSimObject.instance.import_grid_ground_model (req, req, req)
WSSimObject.instance.import_layer_list (req, req)
WSSimObject.instance.import_tvd (req, req, req)
WSSimObject.instance.modified_by ()
WSSimObject.instance.name= (req)
WSSimObject.instance.new_model_object (req, req)
WSSimObject.instance.new_run (req, req, req, req, req, req)
WSSimObject.instance.new_risk_analysis_run (req, req, req, req)
WSSimObject.instance.new_synthetic_rainfall (req, req, req)
WSSimObject.instance.open ()
WSSimObject.instance.open_version (req)
WSSimObject.instance.parent_type ()
WSSimObject.instance.parent_id ()
WSSimObject.instance.path ()
WSSimObject.instance.tvd_unit_type ()
WSSimObject.instance.tvd_unit_type= (req)
WSSimObject.instance.type ()
WSSimObject.instance.update_dashboard ()
WSSimObject.instance.update_to_latest ()
WSRiskAnalysisRunObject.instance.run ()
WSRiskAnalysisRunObject.instance.run_ex (req)
WSRiskAnalysisRunObject.instance.[] (req)
WSRiskAnalysisRunObject.instance.[]= (req, req)
WSRiskAnalysisRunObject.instance.bulk_delete ()
WSRiskAnalysisRunObject.instance.children ()
WSRiskAnalysisRunObject.instance.comment ()
WSRiskAnalysisRunObject.instance.comment= (req)
WSRiskAnalysisRunObject.instance.compare (req)
WSRiskAnalysisRunObject.instance.compare_results_to_file (req, req, req)
WSRiskAnalysisRunObject.instance.compare_to_csv (req, req, req)
WSRiskAnalysisRunObject.instance.copy_here (req, req, req)
WSRiskAnalysisRunObject.instance.csv_import_tvd (req, req, req)
WSRiskAnalysisRunObject.instance.deletable? ()
WSRiskAnalysisRunObject.instance.delete ()
WSRiskAnalysisRunObject.instance.delete_results ()
WSRiskAnalysisRunObject.instance.duplicate_model_object (req)
WSRiskAnalysisRunObject.instance.export (req, req)
WSRiskAnalysisRunObject.instance.find_child_object (req, req)
WSRiskAnalysisRunObject.instance.find_child_model_object (req, req)
WSRiskAnalysisRunObject.instance.id ()
WSRiskAnalysisRunObject.instance.import_data (req, req)
WSRiskAnalysisRunObject.instance.import_new_model_object (req, req, req, req, req)
WSRiskAnalysisRunObject.instance.import_grid_ground_model (req, req, req)
WSRiskAnalysisRunObject.instance.import_layer_list (req, req)
WSRiskAnalysisRunObject.instance.import_tvd (req, req, req)
WSRiskAnalysisRunObject.instance.modified_by ()
WSRiskAnalysisRunObject.instance.name= (req)
WSRiskAnalysisRunObject.instance.new_model_object (req, req)
WSRiskAnalysisRunObject.instance.new_run (req, req, req, req, req, req)
WSRiskAnalysisRunObject.instance.new_risk_analysis_run (req, req, req, req)
WSRiskAnalysisRunObject.instance.new_synthetic_rainfall (req, req, req)
WSRiskAnalysisRunObject.instance.open ()
WSRiskAnalysisRunObject.instance.open_version (req)
WSRiskAnalysisRunObject.instance.parent_type ()
WSRiskAnalysisRunObject.instance.parent_id ()
WSRiskAnalysisRunObject.instance.path ()
WSRiskAnalysisRunObject.instance.tvd_unit_type ()
WSRiskAnalysisRunObject.instance.tvd_unit_type= (req)
WSRiskAnalysisRunObject.instance.type ()
WSRiskAnalysisRunObject.instance.update_dashboard ()
WSRiskAnalysisRunObject.instance.update_to_latest ()
WSModelObjectCollection.instance.[] (req)
WSModelObjectCollection.instance.each ()
WSModelObjectCollection.instance.count ()
WSOpenNetwork.instance.add_scenario (req, req, req)
WSOpenNetwork.instance.befdss_export (req, req, req, req, req)
WSOpenNetwork.instance.befdss_import_cctv (req, req, req, req, req, req, req)
WSOpenNetwork.instance.befdss_import_manhole_surveys (req, req, req, req, req, req, req)
WSOpenNetwork.instance.cctv_standard ()
WSOpenNetwork.instance.clear_selection ()
WSOpenNetwork.instance.close ()
WSOpenNetwork.instance.commit_bypassing_validation (req)
WSOpenNetwork.instance.csv_export (req, req)
WSOpenNetwork.instance.csv_import (req, req)
WSOpenNetwork.instance.current_scenario ()
WSOpenNetwork.instance.current_scenario= (req)
WSOpenNetwork.instance.delete_scenario (req)
WSOpenNetwork.instance.delete_selection ()
WSOpenNetwork.instance.each ()
WSOpenNetwork.instance.each_selected ()
WSOpenNetwork.instance.field_choices (req, req)
WSOpenNetwork.instance.field_choice_descriptions (req, req)
WSOpenNetwork.instance.field_names (req)
WSOpenNetwork.instance.get_projection_string (req)
WSOpenNetwork.instance.get_projection_bounds (req)
WSOpenNetwork.instance.get_string_pref (req, req, req)
WSOpenNetwork.instance.geometry_mbr (req)
WSOpenNetwork.instance.intersect (req)
WSOpenNetwork.instance.load_selection (req)
WSOpenNetwork.instance.mhsurvey_standard ()
WSOpenNetwork.instance.new_row_object (req)
WSOpenNetwork.instance.objects_in_polygon (req, req)
WSOpenNetwork.instance.odic_import (rest)
WSOpenNetwork.instance.odic_import_ex (rest)
WSOpenNetwork.instance.odec_export (rest)
WSOpenNetwork.instance.odec_export_ex (rest)
WSOpenNetwork.instance.open_mo_layer_list (req)
WSOpenNetwork.instance.put_string_pref (req, req)
WSOpenNetwork.instance.row_object (req, req)
WSOpenNetwork.instance.row_objects (req)
WSOpenNetwork.instance.row_objects_from_asset_id (req, req)
WSOpenNetwork.instance.row_object_collection (req)
WSOpenNetwork.instance.row_object_collection_selection (req)
WSOpenNetwork.instance.run_SQL (req, req)
WSOpenNetwork.instance.save_selection (req)
WSOpenNetwork.instance.scenarios ()
WSOpenNetwork.instance.selection_size ()
WSOpenNetwork.instance.search_at_point (req, req, req, req)
WSOpenNetwork.instance.snapshot_export (req)
WSOpenNetwork.instance.snapshot_import (req)
WSOpenNetwork.instance.snapshot_scan (req)
WSOpenNetwork.instance.snapshot_export_ex (req, req)
WSOpenNetwork.instance.snapshot_import_ex (req, req)
WSOpenNetwork.instance.table_names ()
WSOpenNetwork.instance.table (req)
WSOpenNetwork.instance.tables ()
WSOpenNetwork.instance.thin_and_clean_polygons (req)
WSOpenNetwork.instance.transaction_begin ()
WSOpenNetwork.instance.transaction_commit ()
WSOpenNetwork.instance.transaction_rollback ()
WSOpenNetwork.instance.update_cctv_scores ()
WSOpenNetwork.instance.update_cctv_scores_std (req)
WSOpenNetwork.instance.validate (req)
WSOpenNetwork.instance.commit (req)
WSOpenNetwork.instance.revert ()
WSOpenNetwork.instance.run_inference (req, req, req, req, req)
WSOpenNetwork.instance.run_stored_query_object (req)
WSRowObject.instance.[] (req)
WSRowObject.instance.[]= (req, req)
WSRowObject.instance.autoname ()
WSRowObject.instance.category ()
WSRowObject.instance.contains? (req)
WSRowObject.instance.delete ()
WSRowObject.instance.field (req)
WSRowObject.instance.id ()
WSRowObject.instance.id= (req)
WSRowObject.instance.is_inside? (req)
WSRowObject.instance.navigate (req)
WSRowObject.instance.navigate1 (req)
WSRowObject.instance.objects_in_polygon (req)
WSRowObject.instance.selected ()
WSRowObject.instance.selected? ()
WSRowObject.instance.selected= (req)
WSRowObject.instance.table ()
WSRowObject.instance.table_info ()
WSRowObject.instance.write ()
WSRowObject.instance.method_missing (rest)
WSNode.instance.ds_links ()
WSNode.instance.us_links ()
WSNode.instance.[] (req)
WSNode.instance.[]= (req, req)
WSNode.instance.autoname ()
WSNode.instance.category ()
WSNode.instance.contains? (req)
WSNode.instance.delete ()
WSNode.instance.field (req)
WSNode.instance.id ()
WSNode.instance.id= (req)
WSNode.instance.is_inside? (req)
WSNode.instance.navigate (req)
WSNode.instance.navigate1 (req)
WSNode.instance.objects_in_polygon (req)
WSNode.instance.selected ()
WSNode.instance.selected? ()
WSNode.instance.selected= (req)
WSNode.instance.table ()
WSNode.instance.table_info ()
WSNode.instance.write ()
WSNode.instance.method_missing (rest)
WSLink.instance.us_node ()
WSLink.instance.ds_node ()
WSLink.instance.[] (req)
WSLink.instance.[]= (req, req)
WSLink.instance.autoname ()
WSLink.instance.category ()
WSLink.instance.contains? (req)
WSLink.instance.delete ()
WSLink.instance.field (req)
WSLink.instance.id ()
WSLink.instance.id= (req)
WSLink.instance.is_inside? (req)
WSLink.instance.navigate (req)
WSLink.instance.navigate1 (req)
WSLink.instance.objects_in_polygon (req)
WSLink.instance.selected ()
WSLink.instance.selected? ()
WSLink.instance.selected= (req)
WSLink.instance.table ()
WSLink.instance.table_info ()
WSLink.instance.write ()
WSLink.instance.method_missing (rest)
WSStructure.instance.each ()
WSStructure.instance.length ()
WSStructure.instance.length= (req)
WSStructure.instance.size ()
WSStructure.instance.size= (req)
WSStructure.instance.[] (req)
WSStructure.instance.write ()
WSStructureRow.instance.[] (req)
WSStructureRow.instance.[]= (req, req)
WSStructureRow.instance.method_missing (rest)
WSRowObjectCollection.instance.each ()
WSRowObjectCollection.instance.length ()
WSRowObjectCollection.instance.[] (req)
WSTableInfo.instance.description ()
WSTableInfo.instance.fields ()
WSFieldInfo.instance.description ()
WSFieldInfo.instance.fields ()
WSFieldInfo.instance.data_type ()
WSFieldInfo.instance.read_only? ()
WSValidations.instance.each ()
WSValidations.instance.length ()
WSValidations.instance.[] (req)
WSValidations.instance.error_count ()
WSValidations.instance.warning_count ()
WSValidation.instance.code ()
WSValidation.instance.field ()
WSValidation.instance.field_description ()
WSValidation.instance.object_type ()
WSValidation.instance.message ()
WSValidation.instance.priority ()
WSValidation.instance.type ()
WSValidation.instance.scenario ()
WSCommits.instance.each ()
WSCommits.instance.length ()
WSCommits.instance.[] (req)
WSCommit.instance.branch_id ()
WSCommit.instance.comment ()
WSCommit.instance.commit_id ()
WSCommit.instance.date ()
WSCommit.instance.deleted_count ()
WSCommit.instance.inserted_count ()
WSCommit.instance.modified_count ()
WSCommit.instance.setting_changed_count ()
WSCommit.instance.user ()
WSIntersect2.instance.csv_in (req)
WSIntersect2.instance.csv_out (req)
WSIntersect2.instance.html_logger (req)
WSIntersect2.instance.csv_load_failed_polylines (req)
WSIntersect2.instance.csv_load_failed_polygons (req)
WSIntersect2.instance.csv_load_ignored_holes (req)
WSIntersect2.instance.xml_debug_intersection (req)
WSIntersect2.instance.xml_intersection_state (req)
WSIntersect2.instance.thinning (req, req, req)
WSIntersect2.instance.range_restriction (req, req, req)
WSIntersect2.instance.cycle_face_id_containment ()
WSIntersect2.instance.modify (req, req, req, req, req, req, req)
WSIntersect2.instance.compare (req, req)
WSIntersect2.instance.mask_get_point (req)
WSIntersect2.instance.mask_get_polyline (req)
WSIntersect2.instance.mask_get_polygon (req)
WSIntersect2.instance.do_it ()
WSIntersect2.instance.set_lds (req)
WSIntersect2.instance.polygon_category (req)
WSIntersect2.instance.debug_on (req)
WSIntersect2.instance.create_polygons ()
WSIntersect2.instance.log_load_statistics ()
WSIntersect2.instance.log_points ()
WSIntersect2.instance.log_polylines ()
WSIntersect2.instance.log_polygons ()
WSPolygon.instance.add_attribute (req, req, req)
WSPolygon.instance.area ()
WSPolygon.instance.bounds ()
WSPolygon.instance.count_attribute_sets ()
WSPolygon.instance.get_attribute (req, req)
WSPolygon.instance.ids ()
WSPolygon.instance.id_coords (req, req)
WSPolygon.instance.is_valid ()
WSPolygon.instance.valid? ()
WSPolygon.instance.push_back (req, req)
WSPolygon.instance.reserve (req)
WSPolygon.instance.to_xml (req)
WSIWPolygon.instance.set_coords_and_area (req)
WSIWPolygon.instance.[] (req)
WSIWPolygon.instance.[]= (req, req)
WSIWPolygon.instance.autoname ()
WSIWPolygon.instance.category ()
WSIWPolygon.instance.contains? (req)
WSIWPolygon.instance.delete ()
WSIWPolygon.instance.field (req)
WSIWPolygon.instance.id ()
WSIWPolygon.instance.id= (req)
WSIWPolygon.instance.is_inside? (req)
WSIWPolygon.instance.navigate (req)
WSIWPolygon.instance.navigate1 (req)
WSIWPolygon.instance.objects_in_polygon (req)
WSIWPolygon.instance.selected ()
WSIWPolygon.instance.selected? ()
WSIWPolygon.instance.selected= (req)
WSIWPolygon.instance.table ()
WSIWPolygon.instance.table_info ()
WSIWPolygon.instance.write ()
WSIWPolygon.instance.method_missing (rest)
WSBounds.instance.clear ()
WSBounds.instance.add_coord (req, req)
WSBounds.instance.add_bounds (req)
WSBounds.instance.set (req, req, req, req)
WSBounds.instance.valid ()
WSBounds.instance.valid? ()
WSBounds.instance.inside (req, req)
WSBounds.instance.overlap (req)
WSBounds.instance.xmin ()
WSBounds.instance.xmax ()
WSBounds.instance.ymin ()
WSBounds.instance.ymax ()
WSBounds.instance.cx ()
WSBounds.instance.cy ()
WSBounds.instance.dx ()
WSBounds.instance.dy ()
WSBounds.instance.inflate (req)
WSNetSelectionList.instance.count (req)
WSNetSelectionList.instance.from_row_objects (req)
WSNetSelectionList.instance.group_count ()
WSNetSelectionList.instance.group_description (req)
WSNetSelectionList.instance.group_type (req)
WSNetSelectionList.instance.load_from_network (req, req)
WSNetSelectionList.instance.make_selections_in_network (req, req)
WSNetSelectionList.instance.save_to_selection_mo (req)
WSNetSelectionList.instance.to_row_objects (req)
WSSpatialBookmarks.instance.set_bookmark (req, req, req, req, req, req)
WSSpatialBookmarks.instance.new_bookmark_from_selection (req, req, req, req)
WSSpatialBookmarks.instance.delete_bookmark (req)
WSSpatialBookmarks.instance.set_bookmark_bounds (req, req, req)
WSSpatialBookmarks.instance.get_bookmark (req)
WSSpatialBookmarks.instance.load_from_network (req)
WSSpatialBookmarks.instance.save_to_network (req)
WSSpatialBookmarks.instance.load_from_file (req)
WSSpatialBookmarks.instance.save_to_file (req)
WSDongleCheck.ICM_and_InfoNet_method ()
WSDongleCheck.ICM_method ()
WSDongleCheck.InfoNet_method ()
WSDongleCheck.dep_method ()
WSDongleCheck.internal_method ()
Was doing some investigation into WSApplication.log_event()
It seems the first parameter is 'Type' since when invalid numbers are given, ICM will error with 'Type has invalid value'
There are also 3 types available (from testing in UI mode). Still uncertain what this does.
types = {:a=>1,:b=>2,:c=>4}
WSApplication.log_event(types[:a],"<Some string here???>")
Method lists can be found here:
https://gist.github.com/sancarn/9830b8a4c24e38482cef5dd7d3292b52
To create a method list you can use:
https://gist.github.com/sancarn/e706281a070d1b7691e97b06eb8b0d55
I don't have the script which generates the list with arguments etc. saved... 👀
New methods added between ICM v8 and ICM v10:
# Removed
#<WSModelObject>.open_version
#<WSNumbatNetworkObject>.csv_export
#<WSNumbatNetworkObject>.csv_import
#<WSNumbatNetworkObject>.odec_export_ex
#<WSNumbatNetworkObject>.odic_import_ex
#<WSNumbatNetworkObject>.remove_local
# Added
#<WSBaseNetworkObject>.csv_export
#<WSBaseNetworkObject>.csv_import
#<WSBaseNetworkObject>.odec_export_ex
#<WSBaseNetworkObject>.odic_import_ex
#<WSBaseNetworkObject>.remove_local
#<WSNumbatNetworkObject>.branch
#<WSNumbatNetworkObject>.open_version
#<WSOpenNetwork>.InfoAsset_Planner_import
#<WSOpenNetwork>.MDB_export
#<WSOpenNetwork>.choicelists_json
#<WSOpenNetwork>.model_object
#<WSOpenNetwork>.network_model_object
#<WSOpenNetwork>.row_objects_selection
#<WSRowObject>.make_unique_id
#<WSTableInfo>.assetnetworktableclass
#<WSTableInfo>.primaryrelationships_json
#<WSTableInfo>.tableinfo_json
WSApplication::check_in_engine_licence
WSApplication::check_out_engine_licence
WSApplication::checked_out_engine_licence_time_to_expiry
WSApplication::choose_selection
WSApplication::use_checked_out_engine_licence=
WSApplication::use_checked_out_engine_licence?
WSApplication::wds_query_databases
Especially useful is #<WSOpenNetwork>.model_object which can be used to obtain the WSNumbatNetworkObject from a WSOpenNetwork object.