Class Model

Package version

A DTDL model.

Hierarchy

Model

Index

Constructors

constructor

Properties

dict

Methods

Constructors

constructor

new Model(): Model

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:22
Returns Model

Properties

dict

dict: ModelDict

Methods

addType

addType(elementId: string, supplementalTypeId: any, supplementalType: SupplementalTypeInfo): void

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:34
Parameters
- elementId: string
- supplementalTypeId: any
- supplementalType: SupplementalTypeInfo
Returns void

applyTransformations

applyTransformations(parsingErrors: ParsingError[]): void

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:81
Parameters
- parsingErrors: ParsingError[]
Returns void

checkRestrictions

checkRestrictions(parsingErrors: ParsingError[]): void

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:79
Parameters
- parsingErrors: ParsingError[]
Returns void

doesPropertyDictContainKey

doesPropertyDictContainKey(elementId: string, propertyName: string, key?: undefined | string): boolean

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:42
Parameters
- elementId: string
- propertyName: string
- Optional key: undefined | string
Returns boolean

getKindString

getKindString(elementId: string): string

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:72
Parameters
- elementId: string
Returns string

hasElementWithId

hasElementWithId(elementId: string): any

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:85
Parameters
- elementId: string
Returns any

isKindInSet

isKindInSet(elementId: string, kindSet: EntityKinds[]): boolean

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:64
Parameters
- elementId: string
- kindSet: EntityKinds[]
Returns boolean

isPartition

isPartition(elementId: string): boolean

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:30
Parameters
- elementId: string
Returns boolean

setObjectProperties

setObjectProperties(objectPropertyInfoList: ParsedObjectPropertyInfo[], parsingErrors: ParsingError[]): void

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:94
Set the object properties from objectPropertyInfoList on elements in this Model.

Parameters
- objectPropertyInfoList: ParsedObjectPropertyInfo[]
  
  Object property information for the this.
- parsingErrors: ParsingError[]
  
  A list of ParsingErrors to which any parsing error is added.
Returns void

trySetObjectProperty

trySetObjectProperty(elementId: string, propertyName: string, referencedElementId: string, key?: undefined | string): boolean

- Defined in mnt/vss/_work/1/s/sdk/digitaltwins/dtdl-parser/src/parser/model.ts:49
Parameters
- elementId: string
- propertyName: string
- referencedElementId: string
- Optional key: undefined | string
Returns boolean

Generated using TypeDoc