Class UnfWriter

Writer exporting UNF files

see: Unified Nanotechnology Format

Hierarchy

Writer
- UnfWriter

Index

Constructors

constructor

new UnfWriter(structuresToExport: (CgStructureComponent | StructureComponent)[], params?: Partial<UnfWriterParams>): UnfWriter

- Defined in backend/src/catana/writer/unf-writer.ts:50
Parameters
- structuresToExport: (CgStructureComponent | StructureComponent)[]
  
  structure components to be exported
- Default value params: Partial<UnfWriterParams> = {}
  
  writer parameters
Returns UnfWriter

Properties

Private _idGenerator

_idGenerator: number

Private _idMap

_idMap: Map<number, number>

Private _idToVisProp

_idToVisProp: Map<number, VisualizationProperties>

Private _includedStructuresData

_includedStructuresData: string

Private _renumberIds

_renumberIds: boolean

Private Readonly _structuresToExport

_structuresToExport: (CgStructureComponent | StructureComponent)[]

Private Readonly _unfObject

_unfObject: any

Readonly defaultExt

defaultExt: "unf" = "unf"

Readonly defaultName

defaultName: "nanostructure" = "nanostructure"

Readonly exportedUnfVersion

exportedUnfVersion: "1.0.0" = "1.0.0"

Readonly mimeType

mimeType: "text/plain" = "text/plain"

Methods

Private addNewVisProperty

addNewVisProperty(id: number, c: StructureComponent | CgStructureComponent): void

- Defined in backend/src/catana/writer/unf-writer.ts:300
Catana-extension of the UNF format enabling to store some of the visualization settings in the exported file.

Parameters
- id: number
- c: StructureComponent | CgStructureComponent
Returns void

Private appendAllAtomStructure

appendAllAtomStructure(comp: StructureComponent, structure: Structure, position: Vector3, rotation: Euler): void

- Defined in backend/src/catana/writer/unf-writer.ts:150
Appends all-atom structure to the UNF data

Parameters
- comp: StructureComponent
- structure: Structure
- position: Vector3
- rotation: Euler
Returns void

Private appendCatanaSceneData

appendCatanaSceneData(): void

- Defined in backend/src/catana/writer/unf-writer.ts:366
Appends Catana-only data to the UNF file

Returns void

Private appendCoarseGrainedStructure

appendCoarseGrainedStructure(comp: CgStructureComponent, cgStructure: CgStructure, matrix: Matrix4, rotation: Quaternion): void

- Defined in backend/src/catana/writer/unf-writer.ts:188
Appends coarse-grained structure to the UNF data

Parameters
- comp: CgStructureComponent
- cgStructure: CgStructure
- matrix: Matrix4
- rotation: Quaternion
Returns void

Private computeHash

computeHash(stringContent: string): string

- Defined in backend/src/catana/writer/unf-writer.ts:129
Computes a MD5 hash of the source string with all of its line ends removed

Parameters
- stringContent: string
Returns string

download

download(name?: undefined | string, ext?: undefined | string): void

Inherited from Writer.download
- Defined in backend/src/writer/writer.ts:38
Trigger a download of the

Parameters
- Optional name: undefined | string
- Optional ext: undefined | string
Returns void

[description]

Private finalizeUnfObject

finalizeUnfObject(): void

- Defined in backend/src/catana/writer/unf-writer.ts:120
Finalizes the data of the internal UNF object

Returns void

getBlob

getBlob(): Blob

Inherited from Writer.getBlob
- Defined in backend/src/writer/writer.ts:28
Get a blob with the written data

Returns Blob

the blob

getData

getData(): string

Overrides Writer.getData
- Defined in backend/src/catana/writer/unf-writer.ts:74
override

Returns string

Private getGlobalId

getGlobalId(origGlobId: number): number

- Defined in backend/src/catana/writer/unf-writer.ts:281
Returns global ID used in the exported file corresponding to the original global ID of the object

Parameters
- origGlobId: number
  
  original global ID
Returns number

global ID to be used in the UNF file

Private initUnfObject

initUnfObject(storedStructureName: string, authorName: string, strucsToExportCnt: number): any

- Defined in backend/src/catana/writer/unf-writer.ts:88
Initializes empty UNF object

Parameters
- storedStructureName: string
- authorName: string
- strucsToExportCnt: number
Returns any

object with the same structure as UNF's JSON

Private processStructuresToExport

processStructuresToExport(): void

- Defined in backend/src/catana/writer/unf-writer.ts:136
Goes through structures to be exported and appends them to the internal UNF object

Returns void

Generated using TypeDoc