Class Documentation

Hierarchy

Element
- Documentation

Implements

IDocumentation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Documentation(): Documentation

Overrides Element.constructor
- Defined in models/xmi/Documentation.ts:13
Returns Documentation

Properties

Private _contacts

_contacts: Attribute<string>

Private _exporterIDs

_exporterIDs: Attribute<string>

Private _exporterVersions

_exporterVersions: Attribute<string>

Private _exporters

_exporters: Attribute<string>

Private _longDescriptions

_longDescriptions: Attribute<string>

Private _notices

_notices: Attribute<string>

Private _owners

_owners: Attribute<string>

Private _shortDescriptions

_shortDescriptions: Attribute<string>

Private _timestamps

_timestamps: Attribute<Date>

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

contact

get contact(): string | undefined
set contact(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:33
Returns string | undefined
- Defined in models/xmi/Documentation.ts:29
Parameters
- value: string | undefined
Returns void

contents

get contents(): Set<Element>

Inherited from Element.contents
- Defined in models/metamodel/Element.ts:12
Returns Set<Element>

exporter

get exporter(): string | undefined
set exporter(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:57
Returns string | undefined
- Defined in models/xmi/Documentation.ts:53
Parameters
- value: string | undefined
Returns void

exporterID

get exporterID(): string | undefined
set exporterID(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:105
Returns string | undefined
- Defined in models/xmi/Documentation.ts:101
Parameters
- value: string | undefined
Returns void

exporterVersion

get exporterVersion(): string | undefined
set exporterVersion(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:81
Returns string | undefined
- Defined in models/xmi/Documentation.ts:77
Parameters
- value: string | undefined
Returns void

longDescription

get longDescription(): string | undefined
set longDescription(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:129
Returns string | undefined
- Defined in models/xmi/Documentation.ts:125
Parameters
- value: string | undefined
Returns void

notice

get notice(): string | undefined
set notice(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:177
Returns string | undefined
- Defined in models/xmi/Documentation.ts:173
Parameters
- value: string | undefined
Returns void

owner

get owner(): string | undefined
set owner(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:201
Returns string | undefined
- Defined in models/xmi/Documentation.ts:197
Parameters
- value: string | undefined
Returns void

shortDescription

get shortDescription(): string | undefined
set shortDescription(value: string | undefined): void

- Defined in models/xmi/Documentation.ts:153
Returns string | undefined
- Defined in models/xmi/Documentation.ts:149
Parameters
- value: string | undefined
Returns void

timestamp

get timestamp(): Date | undefined
set timestamp(value: Date | undefined): void

- Defined in models/xmi/Documentation.ts:225
Returns Date | undefined
- Defined in models/xmi/Documentation.ts:221
Parameters
- value: Date | undefined
Returns void

Methods

addListener

addListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:597
Parameters
- event: string | symbol
- listener: Function
Returns this

appendChild

appendChild(child: Element): void

Inherited from Element.appendChild
- Defined in models/metamodel/Element.ts:24
Appends a child to this element

Parameters
- child: Element
Returns void

appendContact

appendContact(value: string): boolean

- Defined in models/xmi/Documentation.ts:41
Parameters
- value: string
Returns boolean

appendExporter

appendExporter(value: string): boolean

- Defined in models/xmi/Documentation.ts:65
Parameters
- value: string
Returns boolean

appendExporterID

appendExporterID(value: string): boolean

- Defined in models/xmi/Documentation.ts:113
Parameters
- value: string
Returns boolean

appendExporterVersion

appendExporterVersion(value: string): boolean

- Defined in models/xmi/Documentation.ts:89
Parameters
- value: string
Returns boolean

appendLongDescription

appendLongDescription(value: string): boolean

- Defined in models/xmi/Documentation.ts:137
Parameters
- value: string
Returns boolean

appendNotice

appendNotice(value: string): boolean

- Defined in models/xmi/Documentation.ts:185
Parameters
- value: string
Returns boolean

appendOwner

appendOwner(value: string): boolean

- Defined in models/xmi/Documentation.ts:209
Parameters
- value: string
Returns boolean

appendShortDescription

appendShortDescription(value: string): boolean

- Defined in models/xmi/Documentation.ts:161
Parameters
- value: string
Returns boolean

appendTimestamp

appendTimestamp(value: Date): boolean

- Defined in models/xmi/Documentation.ts:233
Parameters
- value: Date
Returns boolean

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:607
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:608
Returns ( string | symbol ) []

getAllContacts

getAllContacts(): ArbitraryUniqueCollection<string>

- Defined in models/xmi/Documentation.ts:37
Returns ArbitraryUniqueCollection<string>

getAllExporterIDs

getAllExporterIDs(): ArbitraryUniqueCollection<string>

- Defined in models/xmi/Documentation.ts:109
Returns ArbitraryUniqueCollection<string>

getAllExporterVersions

getAllExporterVersions(): ArbitraryUniqueCollection<string>

- Defined in models/xmi/Documentation.ts:85
Returns ArbitraryUniqueCollection<string>

getAllExporters

getAllExporters(): ArbitraryUniqueCollection<string>

- Defined in models/xmi/Documentation.ts:61
Returns ArbitraryUniqueCollection<string>

getAllLongDescriptions

getAllLongDescriptions(): ArbitraryUniqueCollection<string>

Implementation of IDocumentation.getAllLongDescriptions
- Defined in models/xmi/Documentation.ts:133
Returns ArbitraryUniqueCollection<string>

getAllNotices

getAllNotices(): ArbitraryUniqueCollection<string>

Implementation of IDocumentation.getAllNotices
- Defined in models/xmi/Documentation.ts:181
Returns ArbitraryUniqueCollection<string>

getAllOwners

getAllOwners(): ArbitraryUniqueCollection<string>

Implementation of IDocumentation.getAllOwners
- Defined in models/xmi/Documentation.ts:205
Returns ArbitraryUniqueCollection<string>

getAllShortDescriptions

getAllShortDescriptions(): ArbitraryUniqueCollection<string>

Implementation of IDocumentation.getAllShortDescriptions
- Defined in models/xmi/Documentation.ts:157
Returns ArbitraryUniqueCollection<string>

getAllTimestamps

getAllTimestamps(): ArbitraryUniqueCollection<Date>

- Defined in models/xmi/Documentation.ts:229
Returns ArbitraryUniqueCollection<Date>

getHref

getHref(): string | undefined

Inherited from Element.getHref
- Defined in models/metamodel/Element.ts:38
Returns a hyper reference to this element

Returns string | undefined

getID

getID(): string | undefined

Inherited from Element.getID
- Defined in models/metamodel/Element.ts:66
Returns the ID of this element

Returns string | undefined

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:605
Returns number

getOrigin

getOrigin(): string | undefined

Inherited from Element.getOrigin
- Defined in models/metamodel/Element.ts:52
Returns the origin of this element

Returns string | undefined

getTypeName

getTypeName(): string | undefined

Inherited from Element.getTypeName
- Defined in models/metamodel/Element.ts:94
Returns the TypeName of this element

Returns string | undefined

getTypeURI

getTypeURI(): string | undefined

Inherited from Element.getTypeURI
- Defined in models/metamodel/Element.ts:80
Returns the TypeURI of this element

Returns string | undefined

hasContact

hasContact(): boolean

- Defined in models/xmi/Documentation.ts:49
Returns boolean

hasExporter

hasExporter(): boolean

- Defined in models/xmi/Documentation.ts:73
Returns boolean

hasExporterID

hasExporterID(): boolean

- Defined in models/xmi/Documentation.ts:121
Returns boolean

hasExporterVersion

hasExporterVersion(): boolean

- Defined in models/xmi/Documentation.ts:97
Returns boolean

hasLongDescription

hasLongDescription(): boolean

- Defined in models/xmi/Documentation.ts:145
Returns boolean

hasNotice

hasNotice(): boolean

- Defined in models/xmi/Documentation.ts:193
Returns boolean

hasOwner

hasOwner(): boolean

- Defined in models/xmi/Documentation.ts:217
Returns boolean

hasShortDescription

hasShortDescription(): boolean

- Defined in models/xmi/Documentation.ts:169
Returns boolean

hasTimestamp

hasTimestamp(): boolean

- Defined in models/xmi/Documentation.ts:241
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:609
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:606
Parameters
- event: string | symbol
Returns Function[]

merge

merge(other: Element): this

Inherited from Element.merge
- Defined in models/metamodel/Element.ts:103
Merges elements with each other

Parameters
- other: Element
  
  The element to merge
Returns this

on

on(event: string | symbol, listener: Function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:598
Parameters
- event: string | symbol
- listener: Function
Returns this

once

once(event: string | symbol, listener: Function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:599
Parameters
- event: string | symbol
- listener: Function
Returns this

prependListener

prependListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:600
Parameters
- event: string | symbol
- listener: Function
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:601
Parameters
- event: string | symbol
- listener: Function
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:603
Parameters
- Optional event: string | symbol
Returns this

removeChild

removeChild(child: Element): boolean

Inherited from Element.removeChild
- Defined in models/metamodel/Element.ts:31
Removes a child from this element

Parameters
- child: Element
Returns boolean

removeContact

removeContact(value: string): boolean

- Defined in models/xmi/Documentation.ts:45
Parameters
- value: string
Returns boolean

removeExporter

removeExporter(value: string): boolean

- Defined in models/xmi/Documentation.ts:69
Parameters
- value: string
Returns boolean

removeExporterID

removeExporterID(value: string): boolean

- Defined in models/xmi/Documentation.ts:117
Parameters
- value: string
Returns boolean

removeExporterVersion

removeExporterVersion(value: string): boolean

- Defined in models/xmi/Documentation.ts:93
Parameters
- value: string
Returns boolean

removeListener

removeListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:602
Parameters
- event: string | symbol
- listener: Function
Returns this

removeLongDescription

removeLongDescription(value: string): boolean

- Defined in models/xmi/Documentation.ts:141
Parameters
- value: string
Returns boolean

removeNotice

removeNotice(value: string): boolean

- Defined in models/xmi/Documentation.ts:189
Parameters
- value: string
Returns boolean

removeOwner

removeOwner(value: string): boolean

- Defined in models/xmi/Documentation.ts:213
Parameters
- value: string
Returns boolean

removeShortDescription

removeShortDescription(value: string): boolean

- Defined in models/xmi/Documentation.ts:165
Parameters
- value: string
Returns boolean

removeTimestamp

removeTimestamp(value: Date): boolean

- Defined in models/xmi/Documentation.ts:237
Parameters
- value: Date
Returns boolean

setID

setID(ID: string | undefined): void

Inherited from Element.setID
- Defined in models/metamodel/Element.ts:59
Sets the element's ID

Parameters
- ID: string | undefined
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:604
Parameters
- n: number
Returns this

setOrigin

setOrigin(origin: string): void

Inherited from Element.setOrigin
- Defined in models/metamodel/Element.ts:45
Sets the element's origin

Parameters
- origin: string
Returns void

setTypeName

setTypeName(name: string | undefined): void

Inherited from Element.setTypeName
- Defined in models/metamodel/Element.ts:87
Sets the element's type name

Parameters
- name: string | undefined
Returns void

setTypeURI

setTypeURI(uri: string | undefined): void

Inherited from Element.setTypeURI
- Defined in models/metamodel/Element.ts:73
Sets the element's type URI

Parameters
- uri: string | undefined
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:594
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc