IFCImporterObj

This section defines the API for the PML object that performs the import operation.

The member data for the object are as follows.

Below is an example of using the object in User-written PML.

-- create importer object

!importer = object IFCIMPORTEROBJ()

-- configure the object

!importer.setCacheFacets(FALSE)

!importer.setDbTarget(=2013286676/296521 )

!importer.setLogDetail(2)

!importer.setLogFile(|D:\NIST_analysis_models\Duplex_A_20110907.log| )

!importer.setSource(|D:\NIST_analysis_models\Duplex_A_20110907.ifc|)

!importer.setSrcFolderFlg(FALSE)

!importer.setTolerance(1mm)

!importer.setPrefix( |TestModel| )

!importer.setRefDatumOption(TRUE)

!importer.setRefDatumByName(|IFCREVIT|)

-- import

!result = !importer.import()

-- post Process

!importer.postProcess()

-- output result

!!alert.message( !importer.getImportStatus( ) )

-- Process model after import

!importer.userPostProcess(|userPostProcess|)

Customise SUBE Size

The bucket splitting function is used to split the imported ZONE into a series of smaller SUBEs with a defined number of child elements. The default SUBE size of 100 can be customized if the import process is being performed from the command line. A value of less than 25 or more than 1000 cannot be entered. These are hard coded limits. For example:

!importer = object IFCIMPORTEROBJ( )

!importer.setUseBucketSize( true )

!importer.setBucketSize( 50 )

!importer.splitIntoBuckets( true )

The same core bucket splitting function is used to create multiple SUBEs and name the subsequent SUBEs based on the description of the original SUBE. This standalone function can also be called from the Command window to operate on elements other than ZONEs.

define function !!SplitIntoBuckets( !ref is DBREF, !bucketSize is REAL ) is ARRAY

For example, in the Command window or a PML file, if !ref is the reference number of a SUBE, and the required !bucketSize is 50 ().

!list = !!SplitIntoBuckets( !ref, 50)

The function is not SUBE specific and can be used to partition any element.

Model Prefix

Use the setPrefix function to define the model naming prefix that is used in the naming algorithm.

setRefDatumByName

This function call is to use the correct Reference Datum for applying transformations to the imported model. Internally, in the Application Data World the elements have a special suffix of -HDR which is not displayed.

!importer.setRefDatumByName(|IFCREVIT|)

The command above tells the importer to use the Reference Datum /IFCREVIT-HDR as its transformation data.

To use another ZONE that is outside the Application Data World, and is not controlled by this UI, you can set the Reference Datum using its DB Reference Number. For example:

!importer.setRefDatum(!refZone.DBREF())

Import Pre- and Post-Processing Functions

There is scope to define additional operations before and after importing a model. These are pre- and post-processing functions that might operate on the model before or after it has been imported. User-defined pre- and post-processing functions can be called during the data transfer process.

Template functions called userPreImpProcess.pmlfnc and userPostImpProcess.pmlfnc are supplied. The supplied default templates are called automatically from the Graphical User Interface post-process function. If the PML importer object is used, it is possible to provide the same additional functionality as required but they must be called manually when using the importer object.

Note:
The templates do not do anything, but it is possible to use them as a framework for your own requirements.

These can be invoked using the commands:

!importer.userPreProcess()

!importer.userPostProcess()

Alternatively, you may provide your own functions and inject them into the import process. This is achieved by providing a function or even a series of similar functions, <userFunction>.pmlfnc, for example, IFCPostProcessing.pmlfnc, in the PML search path and then plugging it or them into the System using the command line. These functions take one argument and must handle all PML errors internally. The functions return a string result value containing whatever message is to be transmitted to the running PML application. The template PML functions provide an example of how to structure the function.

These can be defined in the importer object as below, but there are defaults of:

• UserPreProcessor = |userPreImpProcess|

• UserPostProcessor = |userPostImpProcess|

For example:

!importer = object IFCIMPORTEROBJ( )

!importer.setUserPreProcessor( |IFCPreProcessing| )

The string values are used to construct a function name, for example, userPreImpProcess.pmlfnc, which the system will attempt to invoke. The import process will not fail if these functions are not found. They are normal PML functions that must be available in the PML search path. A PML REHASH ALL command might be necessary to refresh the PML index files. All error handling must be contained in the files themselves.

When using the PML importer object directly, there are API functions on the importer object to set and get these values.

• define method .setUserPreProcessor( !userPreProcessor is STRING )

• define method .getUserPreProcessor( ) is STRING

• define method .setUserPostProcessor( !userPostProcessor is STRING )

• define method .getUserPostProcessor( ) is STRING

For example:

!importer = object IFCIMPORTEROBJ( )

!importer.setUserPreProcessor( |IFCPreProcessing| )

!importer.userPreProcess()

!importer.import()

!importer.setUserPostProcessor( |IFCPostProcessing| )

!importer.userPostProcess()

Please note that a parameter has been added to pre- or post-processing User function signatures to give User-access to the importer object itself. Note also that the User-definable functions must have a signature similar to the ones below, with the single parameter to the importer object. With the importer object, all the API functions become available within the pre- and post-processing functions.

• define function !!userPostImpProcess( !importer is IFCIMPORTEROBJ ) is STRING

• define function !!userPreImpProcess( !importer is IFCIMPORTEROBJ ) is STRING