Class AcDbDatabaseConverter<TModel>`Abstract`

Abstract base class for database converters.

This class provides the foundation for converting various file formats (such as DXF, DWG) into AcDbDatabase objects. It handles the conversion process in stages and provides progress tracking capabilities.

Example

class MyConverter extends AcDbDatabaseConverter<MyModel> {
  protected parse(data: string | ArrayBuffer): MyModel {
    // Implementation for parsing data
  }

  ......

  protected processEntities(model: MyModel, db: AcDbDatabase) {
    // Implementation for processing entities
  }
}

Type Parameters

TModel = unknown
The type of the parsed model data

Hierarchy (View Summary)

AcDbDatabaseConverter

Index

Constructors

constructor

new AcDbDatabaseConverter<TModel = unknown>(
config?: AcDbDatabaseConverterConfig,
): AcDbDatabaseConverter<TModel>
Creates a new instance of the database converter.
Type Parameters
- TModel = unknown
Parameters
- config: AcDbDatabaseConverterConfig = {}
  Configuration options for the converter. This includes settings such as worker URL for web workers used in the conversion process. If not provided, an empty configuration object will be used.
Returns AcDbDatabaseConverter<TModel>
Example
```
// Create converter with default configuration
const converter = new AcDbDxfConverter();

// Create converter with custom worker URL
const converter = new AcDbDxfConverter({
  parserWorkerUrl: '/assets/dxf-parser-worker.js'
});
```
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:374

Properties

`Readonly`config

config: AcDbDatabaseConverterConfig

Configuration for the converter

`Optional`progress

progress?: AcDbConversionProgressCallback

Optional progress callback for tracking conversion progress

Methods

`Protected`getFonts

getFonts(_model: TModel): string[]
Parameters
- _model: TModel
Returns string[]
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:698

`Protected`getParserWorkerTimeout

getParserWorkerTimeout(data: ArrayBuffer, timeout?: number): number
Resolves the parser worker timeout in milliseconds.

Explicit timeout always takes precedence. Otherwise the timeout scales linearly with file size at one extra second per MiB, clamped to the range of 30 seconds to 2 minutes.
Parameters
- data: ArrayBuffer
- Optionaltimeout: number
Returns number
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:677

`Protected`onError

onError(error: AcCmTaskError): boolean
Parameters
- error: AcCmTaskError
Returns boolean
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:636

`Protected`onFinished

onFinished(): void
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:662

`Protected`parse

parse(
_data: ArrayBuffer,
_timeout?: number,
): Promise<AcDbParsingTaskResult<TModel>>
Parameters
- _data: ArrayBuffer
- Optional_timeout: number
Returns Promise<AcDbParsingTaskResult<TModel>>
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:691

`Protected`processBlocks

processBlocks(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:734

`Protected`processBlockTables

processBlockTables(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:726

`Protected`processDimStyles

processDimStyles(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:710

`Protected`processEntities

processEntities(
    _model: TModel,
    _db: AcDbDatabase,
    _minimumChunkSize: number,
    _percentage: { value: number },
    _progress?: AcDbConversionProgressCallback,
): void
Parameters
- _model: TModel
- _db: AcDbDatabase
- _minimumChunkSize: number
- _percentage: { value: number }
- Optional_progress: AcDbConversionProgressCallback
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:738

`Protected`processHeader

processHeader(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:722

`Protected`processLayers

processLayers(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:714

`Protected`processLineTypes

processLineTypes(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:702

`Protected`processObjects

processObjects(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:730

`Protected`processTextStyles

processTextStyles(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:706

`Protected`processViewports

processViewports(_model: TModel, _db: AcDbDatabase): void
Parameters
- _model: TModel
- _db: AcDbDatabase
Returns void
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:718

read

read(
    data: ArrayBuffer,
    db: AcDbDatabase,
    minimumChunkSize: number,
    progress?: AcDbConversionProgressCallback,
    timeout?: number,
): Promise<void>
Reads and converts data into an AcDbDatabase.

This method orchestrates the entire conversion process, including parsing, processing various components (fonts, linetypes, styles, etc.), and building the final database.
Parameters
- data: ArrayBuffer
  The input data to convert
- db: AcDbDatabase
  The database to populate with converted data
- minimumChunkSize: number
  Minimum chunk size for batch processing
- Optionalprogress: AcDbConversionProgressCallback
  Optional progress callback
- Optionaltimeout: number
Returns Promise<void>
Promise that resolves when conversion is complete
- Defined in data-model/src/database/AcDbDatabaseConverter.ts:392

Class AcDbDatabaseConverter<TModel>Abstract

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AcDbDatabaseConverter<TModel>

Example

Properties

Readonlyconfig

Optionalprogress

Methods

ProtectedgetFonts

Parameters

Returns string[]

ProtectedgetParserWorkerTimeout

Parameters

Returns number

ProtectedonError

Parameters

Returns boolean

ProtectedonFinished

Returns void

Protectedparse

Parameters

Returns Promise<AcDbParsingTaskResult<TModel>>

ProtectedprocessBlocks

Parameters

Returns void

ProtectedprocessBlockTables

Parameters

Returns void

ProtectedprocessDimStyles

Parameters

Returns void

ProtectedprocessEntities

Parameters

Returns void

ProtectedprocessHeader

Parameters

Returns void

ProtectedprocessLayers

Parameters

Returns void

ProtectedprocessLineTypes

Parameters

Returns void

ProtectedprocessObjects

Parameters

Returns void

ProtectedprocessTextStyles

Parameters

Returns void

ProtectedprocessViewports

Parameters

Returns void

read

Parameters

Returns Promise<void>

Settings

On This Page

Class AcDbDatabaseConverter<TModel>`Abstract`

`Readonly`config

`Optional`progress

`Protected`getFonts

`Protected`getParserWorkerTimeout

`Protected`onError

`Protected`onFinished

`Protected`parse

`Protected`processBlocks

`Protected`processBlockTables

`Protected`processDimStyles

`Protected`processEntities

`Protected`processHeader

`Protected`processLayers

`Protected`processLineTypes

`Protected`processObjects

`Protected`processTextStyles

`Protected`processViewports