Interface IModelProvider

Interface defining a provider of IModels that can be used to Create, Open and persist model data

Namespace: Xbim.IO
Assembly: Xbim.Common.dll
Syntax
public interface IModelProvider
Remarks

The implementors can use this to provide the concrete implementation of the IModel without a direct reference to the actual type.

Properties

| Improve this Doc View Source

Capabilities

Describes the capabilities of the underlying model store(s)

Declaration
StoreCapabilities Capabilities { get; }
Property Value
Type Description
StoreCapabilities
| Improve this Doc View Source

EntityFactoryResolver

Gets and sets a delegate to allow consumers to determine the IEntityFactory to build for a given XbimSchemaVersion

Declaration
Func<XbimSchemaVersion, IEntityFactory> EntityFactoryResolver { get; set; }
Property Value
Type Description
System.Func<XbimSchemaVersion, IEntityFactory>

Methods

| Improve this Doc View Source

Close(IModel)

Closes a model and releases any resources

Declaration
void Close(IModel model)
Parameters
Type Name Description
IModel model
| Improve this Doc View Source

Create(XbimSchemaVersion, String)

Creates a new empty persistent model with the provided path

Declaration
IModel Create(XbimSchemaVersion ifcVersion, string dbPath)
Parameters
Type Name Description
XbimSchemaVersion ifcVersion
System.String dbPath
Returns
Type Description
IModel
| Improve this Doc View Source

Create(XbimSchemaVersion, XbimStoreType)

Creates a new empty model, backed by the requested type

Declaration
IModel Create(XbimSchemaVersion ifcVersion, XbimStoreType storageType)
Parameters
Type Name Description
XbimSchemaVersion ifcVersion
XbimStoreType storageType
Returns
Type Description
IModel
| Improve this Doc View Source

GetLocation(IModel)

Gets the location any persisted backing store for the Model

Declaration
string GetLocation(IModel model)
Parameters
Type Name Description
IModel model
Returns
Type Description
System.String
Remarks

For EsentModel this would be the location of the xbim file

| Improve this Doc View Source

GetXbimSchemaVersion(String)

Gets the XbimSchemaVersion of the provided model file

Declaration
XbimSchemaVersion GetXbimSchemaVersion(string modelPath)
Parameters
Type Name Description
System.String modelPath
Returns
Type Description
XbimSchemaVersion
| Improve this Doc View Source

Open(Stream, StorageType, XbimSchemaVersion, XbimModelType, XbimDBAccess, ReportProgressDelegate, Int32)

Opens a model from the provided System.IO.Stream

Declaration
IModel Open(Stream stream, StorageType dataType, XbimSchemaVersion schemaVersion, XbimModelType modelType, XbimDBAccess accessMode = XbimDBAccess.Read, ReportProgressDelegate progDelegate = null, int codePageOverride = -1)
Parameters
Type Name Description
System.IO.Stream stream
StorageType dataType
XbimSchemaVersion schemaVersion
XbimModelType modelType
XbimDBAccess accessMode
ReportProgressDelegate progDelegate
System.Int32 codePageOverride
Returns
Type Description
IModel
| Improve this Doc View Source

Open(String, XbimSchemaVersion, Nullable<Double>, ReportProgressDelegate, XbimDBAccess, Int32)

Opens a model from the given path

Declaration
IModel Open(string path, XbimSchemaVersion schemaVersion, double? ifcDatabaseSizeThreshHold = null, ReportProgressDelegate progDelegate = null, XbimDBAccess accessMode = XbimDBAccess.Read, int codePageOverride = -1)
Parameters
Type Name Description
System.String path
XbimSchemaVersion schemaVersion
System.Nullable<System.Double> ifcDatabaseSizeThreshHold
ReportProgressDelegate progDelegate
XbimDBAccess accessMode
System.Int32 codePageOverride
Returns
Type Description
IModel
| Improve this Doc View Source

Persist(IModel, String, ReportProgressDelegate)

Saves the current model to a persistent store

Declaration
void Persist(IModel model, string fileName, ReportProgressDelegate progDelegate = null)
Parameters
Type Name Description
IModel model
System.String fileName
ReportProgressDelegate progDelegate