Class Conformance

An operational view of conformance as defined by the Matter Specification.

We extend the specification's syntax to add ">", "<", ">=" and "<=". These are required to encode some portions of the specification that are described in prose.

"Conformance" controls when a data field or cluster element is allowed or required.

Hierarchy (view full)

Constructors

constructor

Properties

ast definition errors?

Accessors

empty isMandatory type valid

Methods

equals error extend freeze isApplicable toString validateReferences valueOf

Constructors

constructor

  • new Conformance(definition): Conformance

  • Initialize from a Conformance.Definition or the conformance DSL defined by the Matter Specification.

    Parameters

    Returns Conformance

Properties

ast

ast: Ast

definition

definition: Definition

Optionalerrors

errors?: DefinitionError[]

Accessors

empty

  • get empty(): boolean

  • Returns boolean

isMandatory

  • get isMandatory(): boolean

  • Is the associated element mandatory?

    This supports a limited subset of conformance and is only appropriate for field and requirement conformance.

    Returns boolean

type

  • get type():
        | Special
        | Flag
        | NOT
        | EQ
        | NE
        | OR
        | XOR
        | AND
        | GT
        | LT
        | GTE
        | LTE

  • Returns
        | Special
        | Flag
        | NOT
        | EQ
        | NE
        | OR
        | XOR
        | AND
        | GT
        | LT
        | GTE
        | LTE

valid

  • get valid(): boolean

  • Returns boolean

Methods

equals

  • equals(other): boolean

  • Test for logical equivalence.

    Parameters

    • other: any

    Returns boolean

error

  • error(code, message): void

  • Parameters

    • code: string
    • message: string

    Returns void

extend

freeze

  • freeze(): void

  • Returns void

isApplicable

  • isApplicable(features, supportedFeatures): boolean

  • Perform limited conformance evaluation to determine whether this conformance is applicable given a feature combination.

    Ignores subexpressions that reference field values.

    This is useful for filtering elements at compile time. For complete accuracy you then need to filter at runtime once field values are known.

    Parameters

    • features: Iterable<string, any, any>
    • supportedFeatures: Iterable<string, any, any>

    Returns boolean

toString

  • toString(): string

  • Returns string

validateReferences

  • validateReferences(lookup): void

  • Parameters

    Returns void

valueOf

  • valueOf(): string

  • Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods