The following are the various functions that are for use on Autodesk Fabrication ITM‘s. In most cases, the syntax can be copied/pasted directly into a file and function properly. They should be edited for your particular use. This allows you to short cut your time by not having to experiment to figure out code syntax.
Please take notice of the following notes…
(a) – Undocumented in prior Autodesk documentation
(b) – The first argument of the function sets the “flow” type. 0=Not Set, 1=Supply, 2=Return, 3=None
(c) – {index} is a numerical based index (starting at 1) referring to a particular item in a collection. e.g. “item.connector[2].value” refers to the second connector in the Connector object.
(d) – {index} is a numerical based index (starting at 0) referring to a particular column in the product list. e.g. “item.product.removedim[3]” refers to the third Dimension column in the product list table.
| Function | Notes | Example | Return Value |
|---|---|---|---|
| addcustomdata | item.addcustomdata("Room number") item.addcustomdata(52) | n/a | |
| bitmapfile | item.bitmapfile("./Charlotte/pipe.itm") | image file | |
| candoublewall | item.candoublewall() | True/False | |
| canrotary | (a) | item.canrotary() | True/False |
| dblock.can | item.dblock.can(lock_user) item.dblock.can(lock_owner) | True/False | |
| dblock.setowner | item.dblock.setowner("[owner]","[reason]") | True/False | |
| dblock.setversion | tem.dblock.setversion("[version]","[reason]") | True/False | |
| endlocation | (c) | item.endlocation({index}) item.endlocation({index}, "xyz") item.endlocation({index}, "x") item.endlocation({index}, "y") item.endlocation({index}, "z") item.endlocation({index}, "btm") item.endlocation({index}, "top") | "x y z" "x y z" X Y Z Center Line - (OD/2) Center Line +(OD/2) |
| level | item.level("Floor") item.level("Soffit") | Level | |
| load | item.load("./Charlotte/pipe.itm") | True/False | |
| product.addalias | (a) | item.product.addalias() | True/False |
| product.addarea | (a) | item.product.addarea() | True/False |
| product.addboughtout | (a) | item.product.addboughtout() | True/False |
| product.addcadblock | (a) | item.product.addcadblock() | True/False |
| product.addcustomdata | (a) | item.product.addcustomdata("[name]") item.product.addcustomdata("Field 1") | True/False |
| product.adddatabaseid | (a) | item.product.adddatabaseid() | True/False |
| product.adddim | (a) | item.product.adddim() item.product.adddim("[name]") item.product.adddim("LENGTH") | True/False |
| product.addflow | (a) | item.product.addflow() | True/False |
| product.addoption | (a) | item.product.addoption() item.product.addoption("[name]") item.product.addoption("PIPE PARTS") | True/False |
| product.addorder | (a) | item.product.addorder() | True/False |
| product.addweight | (a) | item.product.addweight() | True/False |
| product.removealias | (a) | item.product.removealias() | True/False |
| product.removearea | (a) | item.product.removearea() | True/False |
| product.removeboughtout | (a) | item.product.removeboughtout() | True/False |
| product.removecadblock | (a) | item.product.removecadblock() | True/False |
| product.removecustomdata | (a) | item.product.removecustomdata("[name]") item.product.removecustomdata("Field 1") | True/False |
| product.removedatabaseid | (a) | item.product.removedatabaseid() | True/False |
| product.removedim | (a)(d) | item.product.removedim([number]) item.product.removedim(3) | True/False |
| product.removeflow | (a) | item.product.removeflow() | True/False |
| product.removeoption | (a)(d) | item.product.removeoption([number]) item.product.removeoption(3) | True/False |
| product.removeorder | (a) | item.product.removeorder() | True/False |
| product.removeweight | (a) | item.product.removeweight() | True/False |
| refreshcosts | item.refreshcosts() | n/a | |
| removeholes | item.removeholes() | n/a | |
| save | item.save("./Charlotte/pipe.itm") | True/False | |
| setdonotcutflag | (a) | item.setdonotcutflag(1, True) | True/False |
| setflow | (b) | item.setflow(0,) item.setflow(1,250) item.setflow(2,250) item.setflow(3,) | True/False |
| update | item.update() | True/False | |
| writedxf | item.writedxf("./mydxfs/elbow", True) item.writedxf("./mydxfs/elbow", False) | True/False |