Sample Code Revit Batch Processor 1.1.11 documentation
DUCT_OVAL_FAMILY_NAME
DUCT_ROUND_FAMILY_NAME
DUCT_RECTANGULAR_FAMILY_NAME
BUILTIN_DUCT_TYPE_FAMILY_NAMES
FLEX_DUCT_REC_FAMILY_NAME
FLEX_DUCT_ROUND_FAMILY_NAME
BUILTIN_FLEX_DUCT_TYPE_FAMILY_NAMES
CONDUIT_WITH_FITTING_FAMILY_NAME
CONDUIT_WITHOUT_FITTING_FAMILY_NAME
BUILTIN_CONDUIT_TYPE_FAMILY_NAMES
CABLE_TRAY_WITH_FITTING_FAMILY_NAME
CABLET_RAY_WITHOUT_FITTING_FAMILY_NAME
BUILTIN_CABLE_TRAY_TYPE_FAMILY_NAMES
PIPE_FAMILY_NAME
BUILTIN_PIPE_TYPE_FAMILY_NAMES
Gets a filtered element collector of all cable tray types in the model. - with fittings - without fittings :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of cable tray types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets a filtered element collector of all cable tray types in the model. - with fittings - without fittings Will exclude in place families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of cable tray types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all cable tray elements placed in model. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of cable tray instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all cable tray elements placed in model. Will exclude in place families. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of cable tray instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all cable tray type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing cable tray types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all cable tray type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing cable tray types. :rtype: List Autodesk.Revit.DB.ElementId
Gets a list of unique symbol ids used in system type properties of cable tray types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of unique ids representing family symbols used in cable tray systems. :rtype: list Autodesk.Revit.DB.ElementId
Gets list of symbol ids of the following categories: - BuiltInCategory.OST_CableTrayFitting :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets a filtered element collector of all conduit types in the model. - with fittings - without fittings :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of conduit types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets a filtered element collector of all conduit types in the model. - with fittings - without fittings Will exclude in place families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of conduit types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all conduit elements placed in model. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of conduit instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all conduit elements placed in model. Will exclude in place families. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of conduit instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all conduit type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all conduit type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets a list of unique symbol ids used in system type properties of conduit types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of unique ids representing family symbols used in conduit systems. :rtype: list Autodesk.Revit.DB.ElementId
Gets list of symbol ids of the following categories: - BuiltInCategory.OST_ConduitFitting :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets a filtered element collector of all duct types in the model. - round - oval - rectangular :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of duct types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets a filtered element collector of all duct types in the model. - round - oval - rectangular Will exclude in place families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of duct types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all duct elements placed in model. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of duct instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all duct elements placed in model. Will exclude in place families. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of duct instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all duct type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all duct type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets a list of unique symbol ids used in system type properties of duct types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of unique ids representing family symbols used in duct systems. :rtype: list Autodesk.Revit.DB.ElementId
Gets list of symbol ids of the following categories: - BuiltInCategory.OST_DuctAccessory, - BuiltInCategory.OST_DuctTerminal, - BuiltInCategory.OST_DuctFitting :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets a filtered element collector of all flex duct types in the model. - round - rectangular :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of flex duct types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets a filtered element collector of all flex duct types in the model. - round - rectangular Will exclude in place families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of flex duct types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all flex duct elements placed in model. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of flex duct instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all flex duct elements placed in model. Will exclude in place families. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of flex duct instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all flex duct type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing flex duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all flex duct type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing flex duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets a list of unique symbol ids used in system type properties of flex duct types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of unique ids representing family symbols used in flex duct systems. :rtype: list Autodesk.Revit.DB.ElementId
Gets list of symbol ids of the following categories: - BuiltInCategory.OST_DuctAccessory, - BuiltInCategory.OST_DuctTerminal, - BuiltInCategory.OST_DuctFitting TODO: flex duct and duct do not differentiate in terms of filtering…one function will get both :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets a filtered element collector of all pipe types in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of pipe tray types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets a filtered element collector of all pipe types in the model. Will exclude in place families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of pipe tray types :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all pipe elements placed in model. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of pipe instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all pipe elements placed in model. Will exclude in place families. TODO: check these actually work… :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of pipe instances :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all pipe type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing pipe types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all pipe type ids available in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing pipe types. :rtype: List Autodesk.Revit.DB.ElementId
Gets a list of unique symbol ids used in system type properties of pipe types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of unique ids representing family symbols used in pipe systems. :rtype: list Autodesk.Revit.DB.ElementId
Gets list of symbol ids of the following categories: - BuiltInCategory.OST_PipeAccessory, - BuiltInCategory.OST_PipeFitting :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all used duct and flex duct symbol ids of categories - BuiltInCategory.OST_DuctAccessory, - BuiltInCategory.OST_DuctTerminal, - BuiltInCategory.OST_DuctFitting Used: at least instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused duct and flex duct symbol ids of categories - BuiltInCategory.OST_DuctAccessory, - BuiltInCategory.OST_DuctTerminal, - BuiltInCategory.OST_DuctFitting Unused: not one instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused duct and flex duct symbol ids of categories - BuiltInCategory.OST_DuctAccessory, - BuiltInCategory.OST_DuctTerminal, - BuiltInCategory.OST_DuctFitting Unused: not one instance per symbol is placed in the model. This method can be used to safely delete unused duct symbols and families from the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all used cable tray symbol ids of categories - BuiltInCategory.OST_CableTrayFitting Used: at least instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused cable tray symbol ids of categories - BuiltInCategory.OST_CableTrayFitting Unused: not one instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused cable tray symbol ids of categories - BuiltInCategory.OST_CableTrayFitting Unused: not one instance per symbol is placed in the model. This method can be used to safely delete unused cable tray symbols and families from the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all used conduit symbol ids of categories - BuiltInCategory.OST_ConduitFitting Used: at least instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused conduit symbol ids of categories - BuiltInCategory.OST_ConduitFitting Unused: not one instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused conduit symbol ids of categories - BuiltInCategory.OST_ConduitFitting Unused: not one instance per symbol is placed in the model. This method can be used to safely delete unused conduit symbols and families from the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all used pipe symbol ids of categories - BuiltInCategory.OST_PipeAccessory, - BuiltInCategory.OST_PipeFitting Used: at least instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused pipe symbol ids of categories - BuiltInCategory.OST_PipeAccessory, - BuiltInCategory.OST_PipeFitting Unused: not one instance per symbol is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all unused pipe symbol ids of categories - BuiltInCategory.OST_PipeAccessory, - BuiltInCategory.OST_PipeFitting Unused: not one instance per symbol is placed in the model. This method can be used to safely delete unused pipe symbols and families from the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of ids representing family symbols. :rtype: list Autodesk.Revit.DB.ElementId
Gets all used duct type ids available in model. Unused: at least instance of each of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all used flex duct type ids available in model. Unused: at least instance of each of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing flex duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all used conduit type ids available in model. Unused: at least instance of each of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all used cable tray type ids available in model. Unused: at least instance of each of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing cable tray types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all used pipe type ids available in model. Unused: at least instance of each of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing pipe types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused duct type ids available in model. Unused: not one instance of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused flex duct type ids available in model. Unused: not one instance of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing flex duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused conduit type ids available in model. Unused: not one instance of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused cable tray type ids available in model. Unused: not one instance of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing cable tray types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused pipe type ids available in model. Unused: not one instance of these types is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing pipe types. :rtype: List Autodesk.Revit.DB.ElementId
Compares two lists of element ids and returns False if any element id in first list is not in the second list. Returns False if any symbols (types) of a family (first list) are in use in a model (second list). TODO: repetitive code…Consider generic function! :param fam_type_ids: List of family symbols (types). :type fam_type_ids: List of Autodesk.Revit.DB.ElementId :param un_used_type_ids: List of unused family symbols (types) :type un_used_type_ids: List of Autodesk.Revit.DB.ElementId :return: True if all ids in first list are also in second list, otherwise False. :rtype: bool
Gets the ids of unused MEP system types. In the case that no mep system instance using any of the types is placed, this will return all but one type id since Revit requires at least one mep system type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :param all_type_id_getter: Function getting all available system type ids as a list. :type all_type_id_getter: func(doc) -> List Autodesk.Revit.ED.ElementId :param all_types_getter: Function getting all available system types as a collector. :type all_types_getter: func(doc) -> Autodesk.Revit.DB.FilteredElementCollector :param built_in_family_type_names: List containing all available major type names. :type built_in_family_type_names: List str :return: A list of ids representing mep system types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused duct type ids. This method can be used to safely delete unused duct types: In the case that no duct instance using any of the types is placed, this will return all but one type id since Revit requires at least one duct type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused flex duct type ids. This method can be used to safely delete unused flex duct types: In the case that no flex duct instance using any of the types is placed, this will return all but one type id since Revit requires at least one flex duct type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing flex duct types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused conduit type ids. This method can be used to safely delete unused conduit types: In the case that no conduit instance using any of the types is placed, this will return all but one type id since Revit requires at least one conduit type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused cable tray type ids. This method can be used to safely delete unused cable tray types: In the case that no cable tray instance using any of the types is placed, this will return all but one type id since Revit requires at least one cable tray type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId
Gets all unused pipe type ids. This method can be used to safely delete unused pipe types: In the case that no pipe instance using any of the types is placed, this will return all but one type id since Revit requires at least one pipe type definition to be in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A list of ids representing conduit types. :rtype: List Autodesk.Revit.DB.ElementId