IFC Patch icon

IFC Patch

Apply IfcPatch recipes to modify IFC files - dynamically loads built-in and custom recipes

IFC Patch

AI-generated

Overview

The IFC Patch node applies IfcPatch recipes to modify IFC (Industry Foundation Classes) files. It allows users to select an input IFC file, choose a recipe (including built-in or custom scripts), and specify output file details. The node supports passing parameters or arguments to the selected recipe, waits for the job to complete if desired, and polls for job status until completion or timeout. This node is useful for automating IFC file modifications such as extracting elements, converting units, or applying custom patches in building information modeling workflows.

Use Case Examples

  1. Extracting all walls from an IFC file using the 'ExtractElements' recipe with a query filter.
  2. Converting length units in an IFC file from meters to feet using the 'ConvertLengthUnit' recipe.
  3. Applying a custom user-defined patch script to an IFC file to modify or add data.

Properties

Name Meaning
Input File Name or ID Select the input IFC file from available files or specify an ID using an expression.
Output File The path or name of the output IFC file to save the modified data.
Recipe Name or ID Select the IfcPatch recipe to execute, including built-in or custom recipes, or specify an ID using an expression.
Query A query string to select a subset of IFC elements, shown only when the 'ExtractElements' recipe is selected.
Target Unit The target length unit for conversion, shown only when the 'ConvertLengthUnit' recipe is selected.
Arguments A collection of arguments to pass to the recipe, used when the recipe is neither 'ExtractElements' nor 'ConvertLengthUnit'. The number and type depend on the selected recipe.
Using Generic Arguments Notice shown when the recipe does not have explicit parameter definitions, advising to use the Arguments collection in the correct order.
Wait for Completion Whether to wait for the job to complete before continuing execution.
Polling Interval (Seconds) How often to check the job status in seconds, shown only if waiting for completion.
Timeout (Seconds) Maximum time to wait for job completion in seconds, shown only if waiting for completion.

Output

JSON

  • job_id - The identifier of the job executing the recipe.
  • error - Error message if the job or recipe execution fails.
  • ``
    • *
      * `` - Additional output data returned from the IfcPatch API after recipe execution.

Dependencies

  • Requires an API key credential for the IfcPipeline API to authenticate requests.

Troubleshooting

  • If the node fails to load recipes, check API credentials and network connection.
  • If the job does not complete within the timeout, increase the timeout or check the job status manually.
  • Errors during recipe execution are returned in the output; use 'Continue On Fail' to handle errors gracefully.

Links

Discussion