The IFC Exporter PML Object

Defines the API for the PML object that can perform the export. It is recommended to use this object as mode data validation is undertaken. The main API methods and attributes are described. There are other internal functions.

The member data for the object are:

Attribute dbSource is an internally structured list for managing the list of exported elements. The first item in the list is used for display purposes. To get the proper list of exported elements, use getExportItems instead, which takes the elements from the second position.

Example Use of IfcExporterObj

The example indicates how the IfcExporterObj PML object can be used.

----------------------------------

-- Create exporter object

----------------------------------

!exporter = object IFCEXPORTEROBJ( )

------------------------------

-- Configure the object

------------------------------

-- Object to export

!ref = =2013286708/2

-- Step 1 - What to export

!exporter.setRefDatumByName(|IFCGLOBAL|)

!exporter.setRefDatumOption(true)

!exporter.setDbSource(!ref)

-- Step 2 - Where to export

!exporter.setDestination(|E:\STEP\Test\TestOutput.ifc|)

!exporter.setOverwriteFlag(true)

-- Step 3 - How to export

!exporter.setVersion(|IFC2x3|)

!exporter.setTolerance(10mm)

!exporter.setInsu(50)

!exporter.setObst(50)

!exporter.setLevel(|CABLE|,6)

!exporter.setLevel(|NOZZ|,6)

!exporter.setLevel(|PIPE|,6)

!exporter.setLevel(|REST|,6)

!exporter.setLevel(|STRU|,6)

!exporter.setRepre(|CLINE|,false)

!exporter.setRepre(|TUBE|,true)

!exporter.setRepre(|AUTOCOL|,true)

!exporter.setRepre(|HOLES|,true)

!exporter.setComponentLevel(true)

!exporter.setDataLevel(|GA|)

-- Step 4 - Logging

!exporter.setLogDetail(2)

!exporter.setLogFile(|E:\STEP\Test\TestOutput.log| )

------------

-- Export

------------

-- Process before export

!exporter.userPreProcess(|userPreExpProcess|)

-- Export

!result = !exporter.export()

-- Process after export

!exporter.userPostProcess(|userPostExpProcess|)

--------------

-- Wrap up

--------------

-- Output result

!!alert.message( !exporter.getExportStatus( ))

Export Pre- and Post-Processing Functions

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

Template functions called userPreExpProcess.pmlfnc and userPostExpProcess.pmlfnc are supplied. The supplied default templates are called automatically from the graphical user interface post-process function. If the PML exporter object is used, it is possible to provide the same additional functionality as required but they must be called manually when using the exporter 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:

!exporter.userPreProcess()

!exporter.userPostProcess()

Alternatively, you may provide your own functions and inject them into the export 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 exporter object as below, but there are defaults of:

• UserPreProcessor = |userPreExpProcess|

• UserPostProcessor = |userPostExpProcess|

For example:

!exporter = object IFCEXPORTEROBJ( )

!exporter.setUserPreProcessor( |IFCPreProcessing| )

The string values are used to construct a function name, for example, userPreExpProcess.pmlfnc, which the System will attempt to invoke. The export 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 exporter object directly, there are API functions on the exporter 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:

!exporter = object IFCEXPORTEROBJ( )

!exporter.setUserPreProcessor( |IFCPreProcessing| )

!exporter.userPreProcess()

!exporter.export()

!exporter.setUserPostProcessor( |IFCPostProcessing| )

!exporter.userPostProcess()

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

• define function !!userPostExpProcess( !exporter is IFCEXPORTEROBJ ) is STRING

• define function !!userPostExpProcess( !exporter is IFCEXPORTEROBJ ) is STRING

Pre-Processing Function

The example finds the elements that need their GUIDs to be set (UUIDIA), instead of just writing out the command message, the actual command syntax can be used to set the attribute.

define function !!IFCPreProcessing( !exporter is IFCEXPORTEROBJ ) is STRING

-- Start

!start = !!ce

-- loop through all elements to export

!items = !!ifcExportForm.exporter.getExportItems()

handle any

!!ce = !start

return |Failure|

endhandle

do !item values !items

-- collect all items to have their GUIDs set

var !unsetGUIDs coll all with ( unset( UUIDIA ) ) for $!item

do !unsetGUID values !unsetGUIDs

!!ce = !unsetGUID.dbref()

!name = name

!message = |Unset GUID on | & !name

write( !message )

write( |UUIDENTIFIER SET| )

enddo

enddo

-- Finished

!!ce = !start

return |Success|

endfunction

setRefDatumByName

The 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.

!exporter.setRefDatumByName(|IFCREVIT|)

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

To use another zone that is outside the Application Data World and not controlled by this User Interface, then set the Reference Datum using the DB Reference Number. For example:

!exporter.setRefDatum(!refZone.DBREF())