A "model" is a class that implements runtime functionality associated with the corresponding element type.

Hierarchy (view full)

Implements

Constructors

Properties

asOf?: `${number}.${number}`
description?: string
details?: string
errors?: DefinitionError[]
id: number
isSeed?: boolean
isType?: boolean

Indicates that an element defines a datatype.

isTypeScope?: boolean

Indicates that an element may have type definitions as children.

mfgCode?: number
name: string
operationalBase?: Model<BaseElement>

Normally base performs lookup based on type. If instead a model is installed it is used as the base.

The operational base also enables resolution from the operational base's tree. This enables resolution on operational models that are not installed in a parent hierarchy.

tag: SemanticNamespace = SemanticNamespaceElement.Tag
type?: string
until?: `${number}.${number}`
types: {
    [type: string]: (new (definition: any) => Model);
} = ...

Factory support. Populated by derivatives upon definition.

Accessors

  • get discriminator(): undefined | string
  • Obtain a discriminator that differentiates different models with the same name

    Returns undefined | string

  • get effectiveId(): undefined | number
  • Allows subclasses to pull a working ID from an alternate source.

    Returns undefined | number

  • get effectiveType(): undefined | string
  • In some circumstances the base type can be inferred. This inference happens here.

    Does not recurse so only returns the direct base type.

    Returns undefined | string

  • get isGlobal(): boolean
  • Determine if this model resides in the global namespace.

    Returns boolean

  • get key(): undefined | string
  • Get a string that uniquely identifies this model. This is normally the effective ID but some models require a generated identifier.

    Returns undefined | string

  • get path(): string
  • The path ("." delimited) in the Matter tree.

    This is informational and generally tries to adhere to JS API conventions.

    Returns string

Methods

  • Freeze the model hierarchy rooted at this model.

    When using a model as operational schema we implement various optimizations that assume the schema is immutable. This function enforces that assumption.

    To make changes to a frozen model use clone.

    Returns void