Class AbstractModel

Abstract: this class should never be instantiated. Implementation of IModel.

Hierarchy

AbstractModel

Implements

IAbstractModel

Index

Constructors

constructor

Properties

Accessors

id
root

Constructors

constructor

new AbstractModel(_client: IModelServerClient, _errorHandler: IErrorCallback): AbstractModel

Parameters
- _client: IModelServerClient
- _errorHandler: IErrorCallback
Returns AbstractModel

Properties

metaModelVersion

metaModelVersion: Version

mxVersionForModel

mxVersionForModel: Version

workingCopy

workingCopy: IWorkingCopy

Accessors

id

get (): string

Returns string

root

get (): IStructuralUnit

Returns IStructuralUnit

Methods

addModuleUnitInterfaces

addModuleUnitInterfaces(structuresJson: string | IAbstractUnitJson[]): IStructuralUnit

Implementation of IAbstractModel.addModuleUnitInterfaces

Parameters
- structuresJson: string | IAbstractUnitJson[]
Returns IStructuralUnit

allUnits

allUnits(): IAbstractUnit[]

Implementation of IAbstractModel.allUnits

Returns a defensive collection of all units in this model.

Returns IAbstractUnit[]

closeConnection

closeConnection(callback: IVoidCallback, errorCallback?: IErrorCallback): void
closeConnection(): Promise<void>

Implementation of IAbstractModel.closeConnection

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.closeConnection

Returns Promise<void>

deleteFile

deleteFile(filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
deleteFile(filePath: string): Promise<void>

Implementation of IAbstractModel.deleteFile

Parameters
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.deleteFile

Parameters
- filePath: string
Returns Promise<void>

deleteWorkingCopy

deleteWorkingCopy(callback: IVoidCallback, errorCallback?: IErrorCallback): void
deleteWorkingCopy(): Promise<void>

Implementation of IAbstractModel.deleteWorkingCopy

Deletes this working copy from the server, and the (SDK) client.

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.deleteWorkingCopy

Returns Promise<void>

exportModuleMpk

exportModuleMpk(moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback?: IErrorCallback): void
exportModuleMpk(moduleId: string, outFilePath: string): Promise<void>

Implementation of IAbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
Returns Promise<void>

exportMpk

exportMpk(outFilePath: string, callback: IExportMpkCallback, errorCallback?: IErrorCallback): void
exportMpk(outFilePath: string): Promise<IExportMpkResponse>

Implementation of IAbstractModel.exportMpk

Parameters
- outFilePath: string
- callback: IExportMpkCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.exportMpk

Parameters
- outFilePath: string
Returns Promise<IExportMpkResponse>

filterUnitsByCustomWidgetId

filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string, callback: ICallback<string[]>, errorCallback: IErrorCallback): void
filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string): Promise<string[]>

Parameters
- workingCopyId: string
- widgetId: string
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
Returns Promise<string[]>

flushChanges

flushChanges(callback: IVoidCallback, errorCallback?: IErrorCallback): void
flushChanges(): Promise<void>

Implementation of IAbstractModel.flushChanges

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.flushChanges

Returns Promise<void>

getFile

getFile(filePath: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
getFile(filePath: string, outFilePath: string): Promise<void>

Parameters
- filePath: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.getFile

Parameters
- filePath: string
- outFilePath: string
Returns Promise<void>

getFilePaths

getFilePaths(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
getFilePaths(): Promise<string[]>

Implementation of IAbstractModel.getFilePaths

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.getFilePaths

Returns Promise<string[]>

getFiles

getFiles(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
getFiles(): Promise<string[]>
getFiles(options: IGetFilesOptions, callback: ICallback<string[] | any>, errorCallback: IErrorCallback): void
getFiles(options: IGetFilesOptions): Promise<string[] | any>

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.getFiles

Returns Promise<string[]>
Parameters
- options: IGetFilesOptions
- callback: ICallback<string[] | any>
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.getFiles

Parameters
- options: IGetFilesOptions
Returns Promise<string[] | any>

getLastEventId

getLastEventId(callback: ICallback<number>, errorCallback?: IErrorCallback): void
getLastEventId(): Promise<number>

Implementation of IAbstractModel.getLastEventId

Parameters
- callback: ICallback<number>
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.getLastEventId

Returns Promise<number>

handleError

handleError(message: string, errorCallback: IErrorCallback | undefined): void

Parameters
- message: string
- errorCallback: IErrorCallback | undefined
Returns void

importModuleMpk

importModuleMpk(mpkPath: string | Blob, callback: IVoidCallback, errorCallback?: IErrorCallback): void
importModuleMpk(mpkPath: string | Blob): Promise<void>

Implementation of IAbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
Returns Promise<void>

loadUnitById

loadUnitById<T>(id: string, forceRefresh: boolean | undefined, callback: ICallback<T>, errorCallback?: IErrorCallback): void
loadUnitById<T>(id: string, forceRefresh: boolean | undefined): Promise<T>

Fetches a complete unit. The result might be returned from the cache.

Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
- callback: ICallback<T>
- Optional errorCallback: IErrorCallback
Returns void
Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
Returns Promise<T>

onBuildResultEventReceived

onBuildResultEventReceived(callback: function): void

Parameters
- callback: function
  - - (buildResultEvent: IBuildResultEvent): void
    - Parameters
      - buildResultEvent: IBuildResultEvent
      Returns void
Returns void

onFileChangesReceived

onFileChangesReceived(callback: function): void

Parameters
- callback: function
  - - (files: string[]): void
    - Parameters
      - files: string[]
      Returns void
Returns void

onModelChange

onModelChange(callback: IVoidCallback): void

Implementation of IAbstractModel.onModelChange

Parameters
- callback: IVoidCallback
Returns void

onModelEventProcessed

onModelEventProcessed(callback: IVoidCallback): void

Implementation of IAbstractModel.onModelEventProcessed

Parameters
- callback: IVoidCallback
Returns void

onWorkingCopyDataEventReceived

onWorkingCopyDataEventReceived(callback: function): void

Parameters
- callback: function
  - - (workingCopyDataEvent: IWorkingCopyDataEvent): void
    - Parameters
      - workingCopyDataEvent: IWorkingCopyDataEvent
      Returns void
Returns void

putFile

putFile(inFilePath: string | Blob, filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
putFile(inFilePath: string | Blob, filePath: string): Promise<void>

Implementation of IAbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IAbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
Returns Promise<void>

setErrorHandler

setErrorHandler(callback: IErrorCallback): void

Implementation of IAbstractModel.setErrorHandler

Parameters
- callback: IErrorCallback
Returns void

startReceivingModelEvents

startReceivingModelEvents(): void

Implementation of IAbstractModel.startReceivingModelEvents

Before calling this API, ensure that all handlers (i.e. onModelEventProcessed()), have been registered

Returns void

startReceivingWorkingCopyEvents

startReceivingWorkingCopyEvents(): void

Implementation of IAbstractModel.startReceivingWorkingCopyEvents

Before calling this API, ensure that all handlers (i.e. onBuildResultEventReceived() and/or onWorkingCopyDataEventReceived() ), have been registered

Returns void

stopReceivingModelEvents

stopReceivingModelEvents(): void

Implementation of IAbstractModel.stopReceivingModelEvents

Returns void

stopReceivingWorkingCopyEvents

stopReceivingWorkingCopyEvents(): void

Implementation of IAbstractModel.stopReceivingWorkingCopyEvents

Returns void

Generated using TypeDoc