Using the Command Line
- Last UpdatedApr 27, 2023
- 4 minute read
MultiCAD Import command line syntax
The command line syntax for importing a MultiCAD file or folder is illustrated below, it is a variant of the IMP command also used for MEI and IFC Imports.
The functionality does a number of checks dynamically before issuing an IMP command. When operating from the command line invalid data will generally result in an error, which can be handled in PML in the usual manner.
In these examples we will use "W:\example_data\example.jt" as a path to a CAD File.
Simple Command
Example:
IMP MULTICAD "W:\example_data\example.jt"
This command is the simplest form of the command - supplying a path to the CAD file, and using default values for all the other parameters. These other parameters can be added as required.
There are some other parameters and sub commands which apply to other variants of the IMP command, but not to IMP MULTICAD, these are not described here.
Limit the number of members for an element
Examples:
IMP MULTICAD "W:\example_data\example.jt" BUCKETSIZE 50
IMP MULTICAD "W:\example_data\example.jt" BUCK 100
The bucketsize option is equivalent to the limit in the Storage pane of the MultiCAD Import window. The E3D Design database performs best when the number of members of each element is not excessive.
Set a bucket size to limit, as far as possible, the number of elements in each level of the database to that number. The default is not to limit the number of members
Choosing a Scale
Examples:
IMP MULTICAD "W:\example_data\example.jt" SCALE 25.4
IMP MULTICAD "W:\example_data\example.jt" SCALE 0.1
This SCALE not displayed in the MultiCAD Import window. It applies a uniform scale to the imported model. This is combined with an scale from a reference datum and from units settings within the CAD file (if any). The default is a scale of 1.0.
Choosing a Reference Datum
Examples:
IMP MULTICAD "W:\example_data\example.jt" WRT /IFCGLOBAL-HDR
IMP MULTICAD "W:\example_data\example.jt" WRT /Scale1000-HDR
This WRT option (or its IN synonym) takes a element which is typically a hidden zone whose name is that of the reference datum in the drop down list in the Reference Datum pane of the MultiCAD Import window with a suffix of -HDR. It is possible to navigate to the element in the hierarchy. The default is not to reposition, reorientate or scale the model.
Note:
In most cases when using the IMP MULTICAD command, it is better to use the SCALE option
(if required) and the standard positioning and orientation commands rather than a
reference datum.
Choosing the Owning E3D Element
Examples:
IMP MULTICAD "W:\example_data\example.jt" TO CE
IMP MULTICAD "W:\example_data\example.jt" TO /ZONE-XXXX
IMP MULTICAD "W:\example_data\example.jt" TO SITE 3 of WORLD
This TO option is equivalent to the Select Owner field in the Import Settings pane of the MultiCAD Import window. It selects where in the E3D Design hierarchy the CAD model should be imported. Valid types are SITE, ZONE, EQUI, VOLM, STRU and FRMW, the default is the current element (CE).
Choosing the E3D Element type to create
Examples:
IMP MULTICAD "W:\example_data\example.jt" AS EQUI
IMP MULTICAD "W:\example_data\example.jt" AS VOLM
This AS option is equivalent to the Import Model As drop- down list in the Import Settings pane of the MulitCAD Import window. It selects the type of E3D Element to be used as the main container element.
Valid element types are EQUI, VOLM, STRU, FRMW, SUBE, SVOLM, SUBS, SBFR (but must be compatible with the type of the TO element, for example: a SUBE cannot be created as a member of a FRMW).
If the TO type is the same as the AS type, then the model will be imported directly into the TO element, in addition to any members it already has.
Any intermediate elements needed between the TO element and the AS type will be created automatically, the default is VOLM.
Choosing a Group-World
Examples:
IMP MULTICAD "W:\example_data\example.jt" GPWL /IFC_Import
IMP MULTICAD "W:\example_data\example.jt" GPWL /CAD_Import_January
This GPWL option is not displayed in the MultiCAD Import window. It allows you to organize the secondary database hierarchy used for the MultiCAD Explorer.
The default Group World is shared with IFC import. If /IFC_Import Group World already exists in the Database then this is used as the default Group World, otherwise a Group World named /MultiCAD_Import Group World is created (if it does not already exist).
Logging
Examples:
IMP MULTICAD "W:\example_data\example.jt" LOG OFF
IMP MULTICAD "W:\example_data\example.jt" LOG BRIEF
IMP MULTICAD "W:\example_data\example.jt" LOG BRIEF "W:/logfiles/aLogfile.txt"
IMP MULTICAD "W:\example_data\example.jt" LOG FULL "W:/logfiles/aLogfile.txt"
This LOG option is equivalent to the LogFile pane of the MultiCAD Import window.
A log file will be produced by default with a name based on that of the CAD file (the log file can be turned off). To produce a log file, select one of the options and provide a valid file path. If this is an existing file, it will be overwritten.