duHast.Revit.Family.Reporting package

Subpackages

• duHast.Revit.Family.Reporting.Objects package
  • Submodules
  • duHast.Revit.Family.Reporting.Objects.family_report_data module
    • Family data storage class.
    • FamilyReportData
      • FamilyReportData.project_name
      • FamilyReportData.family_category
      • FamilyReportData.family_name
      • FamilyReportData.family_type_name
      • FamilyReportData.family_instances_placed
      • FamilyReportData.nested_families
      • FamilyReportData.add_nested_family()
      • FamilyReportData.is_host
      • FamilyReportData.type_properties
      • FamilyReportData.add_type_property()
      • FamilyReportData.is_shared
      • FamilyReportData.get_properties_as_list_str()
      • FamilyReportData.get_property_headers()
  • Module contents

Submodules

duHast.Revit.Family.Reporting.report module

Module containing reporting functions.

• families

duHast.Revit.Family.Reporting.report.report_loaded_families(doc, parameter_names_filter=['Sample Parameter One', 'Sample Parameter Two', 'Sample Parameter Three'], progress_callback=None)

Reports on loaded families:

• family name

• family type

• family category

• specific family type parameters and their values

• family instances placed by by type in model

Parameters:

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

• output (func(message)) – A function piping messages to designated target.

Returns:

Result class instance.

• result.status False if an exception occurred, otherwise True.

• result.message will contain processing messages.

• result.result family data array

On exception:

• result.status (bool) will be False.

• result.message will contain the exception message.

• result.result will be an empty list

Return type:

Result

Module contents