duHast.Revit.Links package

Subpackages

• duHast.Revit.Links.Reporting package
  • Submodules
  • duHast.Revit.Links.Reporting.cad_links_report_header module
    • This module contains the header row for any CAD link reports.
    • REPORT_CAD_LINKS_HEADER
  • duHast.Revit.Links.Reporting.cad_links_report_utils module
    • This module contains utility function(s) for CAD link reports.
    • get_cad_link_type_data_by_name()
    • get_cad_report_data()
  • duHast.Revit.Links.Reporting.links_report_header module
    • This module contains the header row for any revit link reports.
    • REPORT_REVIT_LINKS_HEADER
  • duHast.Revit.Links.Reporting.links_report_utils module
    • This module contains utility function(s) for Revit link reports.
    • get_revit_link_type_data()
    • get_revit_link_report_data()
  • Module contents
• duHast.Revit.Links.Utility package
  • Submodules
  • duHast.Revit.Links.Utility.link_path module
    • get_link_path()
  • duHast.Revit.Links.Utility.link_visibility module
    • This module contains a number of helper functions relating to Revit links, CAD links and image links.
    • is_link_workset_visible()
    • is_link_hidden()
    • is_link_visible()
  • Module contents

Submodules

duHast.Revit.Links.cad_links module

This module contains a number of helper functions relating to CAD links.

duHast.Revit.Links.cad_links.get_all_cad_link_types(doc)

Gets all CAD link types in a model. Filters by class. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of CAD link types :rtype: Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.cad_links.get_all_cad_link_instances(doc)

Gets all CAD link instances in a model. Filters by class. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of import instances :rtype: Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.cad_links.get_cad_type_imports_only(doc)

Gets all CAD imports in a model. Filters by class and check whether the element is an external file reference (True its a link, False it is an import) :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of all CAD imports in a model. :rtype: list Autodesk.Revit.DB.CADLinkType

duHast.Revit.Links.cad_links.sort_cad_link_types_by_model_or_view_specific(doc)

Returns two lists: First one: cad links types linked by view (2D) , second one cad link types linked into model (3D). :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: Two lists of cad link types. :rtype: list Autodesk.Revit.DB.CADLinkType, list Autodesk.Revit.DB.CADLinkType

duHast.Revit.Links.cad_links.get_all_cad_link_type_by_view_only(doc)

Gets all CAD links by view in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: Lists of cad link types. :rtype: list Autodesk.Revit.DB.CADLinkType

duHast.Revit.Links.cad_links.get_all_cad_link_type_in_model_only(doc)

Gets all CAD links by model in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: Lists of cad link types. :rtype: list Autodesk.Revit.DB.CADLinkType

duHast.Revit.Links.cad_links.delete_cad_links(doc)

Deletes all CAD links in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: Result class instance.

• .status True if all CAD links got deleted. Otherwise False.

• .message will contain status of deletion.

Return type:

Result

duHast.Revit.Links.cad_links.reload_cad_links(doc, link_locations, host_name_formatted, do_something_with_link_name)

Reloads CAD links from a given file location based on the original link type name (starts with comparison)

Parameters:

• doc (Autodesk.Revit.DB.Document) – Current Revit model document.

• link_locations (list str) – A list of directories where CAD files can be located.

• host_name_formatted (TBC) – Not used yet

• do_something_with_link_name (func(str) -> str) – A function which amends the link name prior search for a match in folders. I.e. can be used to truncate the link name i.e. the revision details of a link

Returns:

Result class instance.

• .status True if all CAD links got reloaded successfully. Otherwise False.

• .message will contain status of reload and fully qualified file name. On exception it will also include the exception message.

Return type:

Result

duHast.Revit.Links.cad_links_geometry module

This module contains a number of helper functions relating to CAD link geometry.

duHast.Revit.Links.cad_links_geometry.get_cad_import_instance_geometry(import_instance)

Returns a list of geometry elements from an import instance :param import_instance: A import instance :type import_instance: AutoDesk.Revit.DB.ImportInstance :return: A list of geometry objects. Can return an empty list! :rtype: [Autodesk.Revit.DB GeometryObject]

duHast.Revit.Links.cad_links_geometry.get_all_cad_import_instances_geometry(doc)

Returns a list of geometry elements from all import instances in the document. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of geometry objects. Can return an empty list! :rtype: [Autodesk.Revit.DB GeometryObject]

duHast.Revit.Links.image_links module

This module contains a number of helper functions relating to image links.

duHast.Revit.Links.image_links.get_images_types_in_model(doc)

Gets all image link types and image link instances in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of image types. :rtype: Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.image_links.get_images_type_ids_in_model(doc)

Gets all image link type Ids and image link instance ids in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing image types and image instances. :rtype: list Autodesk.Revit.DB.ElementId

duHast.Revit.Links.image_links.sort_image_link_types_by_import_or_linked(doc)

Returns two lists: First one: images linked into model, second one images saved into model from model itself (no external file reference) :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: Two lists of image types and instances (?) :rtype: list Autodesk.Revit.DB.ImageType, list Autodesk.Revit.DB.ImageType

duHast.Revit.Links.image_links.get_all_image_link_type_linked_in_model(doc)

Gets all image link types which are links (external referenced) in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of image types and instances (?) :rtype: list Autodesk.Revit.DB.ImageType

duHast.Revit.Links.image_links.get_all_image_link_type_imported_in_model(doc)

Gets all image link types which are imported (not an external reference) in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of image types and instances (?) :rtype: list Autodesk.Revit.DB.ImageType

duHast.Revit.Links.image_links.get_image_types_in_model(doc)

Gets all image types in a model. Filters by category. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of image types. :rtype: Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.image_links.get_image_instances_in_model(doc)

Gets all image instances placed in a model. Filters by category. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of image instances. :rtype: Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.links module

This module contains a number of helper functions relating to Revit links, CAD links and image links.

duHast.Revit.Links.links.get_all_revit_link_instances(doc)

Gets all Revit link instances in a model.

Filters by class.

Parameters:

doc (Autodesk.Revit.DB.Document) – Current Revit model document.

Returns:

A filtered element collector of revit link instances.

Return type:

Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.links.get_all_revit_link_types(doc)

Gets all Revit link types in a model.

Parameters:

doc (Autodesk.Revit.DB.Document) – Current Revit model document.

Returns:

A filtered element collector of revit link types.

Return type:

Autodesk.Revit.DB.FilteredElementCollector

duHast.Revit.Links.links.get_revit_link_type_from_instance(doc, link_instance)

Gets the Revit link type from a given revit link instance.

Parameters:

• doc (Autodesk.Revit.DB.Document) – Current Revit model document.

• link_instance (Autodesk.Revit.DB.RevitLinkInstance) – The link instance the type of is to be returned

Returns:

The matching revit link type.

Return type:

Autodesk.Revit.DB.RevitLinkType

duHast.Revit.Links.links.get_link_docs(doc, link_names_filter=[])

Gets the link documents for the specified link names.

Parameters:

• doc (Autodesk.Revit.DB.Document) – The current Revit model document.

• link_names_filter (list[str]) – A list of link names to filter. Default is an empty list.

Returns:

A dictionary mapping link names to their respective link documents.

Return type:

dict[str, Autodesk.Revit.DB.Document]

duHast.Revit.Links.links.delete_revit_links(doc)

Deletes all revit links in a file.

Parameters:

doc (Autodesk.Revit.DB.Document) – Current Revit model document.

Returns:

Result class instance.

• .status True if all revit links got deleted successfully. Otherwise False.

• .message will contain deletion status. On exception it will also include the exception message.

Return type:

Result

duHast.Revit.Links.links.reload_revit_links(doc, link_locations, host_name_formatted, do_something_with_link_name, workset_config)

Reloads Revit links from a given file location based on the original link type name (starts with comparison)

Parameters:

• doc (Autodesk.Revit.DB.Document) – Current Revit model document.

• link_locations (list str) – A list of directories where CAD files can be located.

• host_name_formatted (TBC) – Not used yet

• do_something_with_link_name (func(str) -> str) – A function which amends the link name prior search for a match in folders. I.e. can be used to truncate the link name i.e. the revision details of a link

• workset_config (Autodesk.Revit.DB.WorksetConfiguration) – To use the previously applied workset config use None, otherwise provide custom config.

Returns:

Result class instance.

• .status True if all revit links got reloaded successfully. Otherwise False.

• .message will contain status of reload and fully qualified file name. On exception it will also include the exception message.

Return type:

Result

duHast.Revit.Links.links.reload_revit_links_from_list(doc, link_types_tob_reloaded, link_locations, host_name_formatted, do_something_with_link_name, workset_config)

Reloads Revit links from a given file location based on the original link type name (starts with comparison)

Parameters:

• doc (Autodesk.Revit.DB.Document) – Current Revit model document.

• link_types_tob_reloaded (list Autodesk.Revit.DB.RevitLinkType) – List of link type elements to be reloaded.

• link_locations (list str) – A list of directories where CAD files can be located.

• host_name_formatted (TBC) – Not used yet

• do_something_with_link_name (func(str) -> str) – A function which amends the link name prior search for a match in folders. I.e. can be used to truncate the link name i.e. the revision details of a link

• workset_config (Autodesk.Revit.DB.WorksetConfiguration) – To use the previously applied workset config use None, otherwise provide custom config.

Returns:

Result class instance.

• .status True if all revit links got reloaded successfully. Otherwise False.

• .message will contain status of reload and fully qualified file name. On exception it will also include the exception message.

Return type:

Result

duHast.Revit.Links.links.default_link_name(name)

Default ‘do something with link name’ method. Returns the link name unchanged.

Could be replaced with something which i.e. truncates the revision…

Parameters:

name (str) – The link name.

Returns:

the link name unchanged.

Return type:

str

duHast.Revit.Links.links.default_workset_config_for_reload()

Default method returning an ‘open previous worksets’ configuration. (None)

Returns:

None: which is use the previous workset configuration.

Return type:

None

duHast.Revit.Links.purge_unused_image_link_types module

This module contains a number of helper functions relating to purging unused image links.

duHast.Revit.Links.purge_unused_image_link_types.get_all_unused_image_type_ids_in_model(doc)

Gets all image types with no instances placed in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing image types. :rtype: list Autodesk.Revit.DB.ElementId

duHast.Revit.Links.purge_unused_image_link_types.get_all_unused_image_type_ids_in_model_with_group_check(doc)

Gets all image types with no instance placed in a model but includes group definition check. This only returns valid data if at least one instance of the group is placed in the model!! Otherwise images in groups which are not placed will not be flagged by this filter! :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing image types. :rtype: list Autodesk.Revit.DB.ElementId

Module contents