Class IfcApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.IfcApi

public class IfcApi
extends SubApi

IFC related API calls

Constructor Summary

Constructors

Constructor	Description
IfcApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
InputStream	downloadErrorModel(UUID errorUuid)	Download the IFC model of an Error.
InputStream	downloadModel(UUID versionUuid)	Download a model, this will return the byte-for-byte original IFC model
InputStream	export(Set<UUID> versionUuids, String query)	Export a new IFC model from one or more models, filtered by the given query.

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IfcApi

public IfcApi(BimWorksClient bimWorksClient)

Method Details

downloadModel

public InputStream downloadModel(UUID versionUuid)
                          throws BimWorksException

Download a model, this will return the byte-for-byte original IFC model

Parameters:

versionUuid - The UUID of the Version to download

Returns:

An InputStream that can be used to get the content. Responsibility for closing this stream is on the caller.

Throws:

BimWorksException

downloadErrorModel

public InputStream downloadErrorModel(UUID errorUuid)
                               throws BimWorksException

Download the IFC model of an Error. This can be useful for debugging.

Parameters:

errorUuid - The UUID of the Error

Returns:

An InputStream that can be used to get the content. Responsibility for closing this stream is on the caller.

Throws:

BimWorksException

export

public InputStream export(Set<UUID> versionUuids,
 String query)
                   throws BimWorksException

Export a new IFC model from one or more models, filtered by the given query. The query should not contain a GET statement, if it does it is ignored. Only subclasses of IfcProduct can be queried. By default all geometric representations are also included in the results. The decomposes/containment tree all the way up to IfcProject is included for each result. For IfcProject also the UnitAssignment is always included, as are the OwnerHistory objects, to make it a valid IFC file. When querying multiple models, it should be expected that the resulting IFC will not be valid. For example it will usually have multiple IfcProject entities.

Parameters:

versionUuids - The Version UUIDs of the models to query

query - The BQL query to filter by

Returns:

An InputStream, closing the InputStream is the responsibility of the caller

Throws:

BimWorksException