/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ import { Conformance } from "#aspects/Conformance.js"; import { ModelIndex } from "#logic/ModelIndex.js"; import { Access } from "../aspects/Access.js"; import { Quality } from "../aspects/Quality.js"; import { ElementTag, FeatureSet, Metatype } from "../common/index.js"; import { ClusterElement } from "../elements/index.js"; import { AttributeModel } from "./AttributeModel.js"; import { CommandModel } from "./CommandModel.js"; import { DatatypeModel } from "./DatatypeModel.js"; import { EventModel } from "./EventModel.js"; import { FieldModel } from "./FieldModel.js"; import { Model } from "./Model.js"; import { ScopeModel } from "./ScopeModel.js"; export declare class ClusterModel extends ScopeModel implements ClusterElement, Conformance.FeatureContext { #private; tag: ClusterElement.Tag; classification?: ClusterElement.Classification; bindable?: boolean; get diagnostics(): boolean | undefined; get quality(): Quality; set quality(definition: Quality | Quality.Definition); get effectiveQuality(): Quality; /** * Whether a Binding entry may direct a client of this cluster: the {@link bindable} of this cluster or, where * unset, of the closest cluster it derives from that sets it; `true` when none does. */ get effectiveBindable(): boolean; /** * The {@link classification} of this cluster or, where unset, of the closest cluster it derives from that sets it; * undefined when none does. * * @see {@link MatterSpecification.v161.Core} § 7.10.8 */ get effectiveClassification(): ClusterElement.Classification | undefined; get attributes(): ModelIndex; get commands(): ModelIndex; get events(): ModelIndex; get datatypes(): ModelIndex; /** * The cluster's own status codes, if it defines any. * * Status code range 0x02 - 0x10 is reserved for cluster-scoped codes, so a value of the global "status" type in * such a cluster carries either these codes or the global ones. * * @see {@link MatterSpecification.v161.Core} § 8.10 */ get statusCodes(): DatatypeModel | undefined; /** * Fields on a cluster are not part of the standard Matter data model. They are used for internal extensions that * should not be served via the Matter protocol. */ get fields(): ModelIndex; /** * Attributes and fields, for treating a cluster as a struct. */ get properties(): ModelIndex; get conformant(): ClusterModel.Conformant; get pics(): string | undefined; set pics(pics: string | undefined); /** * Get attributes, commands and events whether inherited or defined directly in this model. */ get allAces(): ModelIndex; get revision(): number; get features(): FieldModel[]; get featureMap(): AttributeModel; get definedFeatures(): FeatureSet; /** * Features the implementation supports. * * A feature's `default` conveys the specification's fallback value and never implies support. */ get supportedFeatures(): FeatureSet; /** * Features the specification mandates without condition. * * These are not an application choice. A server implementation supports them regardless of selection; a client * defers to the features its peer reports. */ get unconditionalFeatures(): FeatureSet; set supportedFeatures(features: FeatureSet.Definition | undefined); get effectiveMetatype(): Metatype; get effectiveAccess(): Access; constructor(definition: ClusterModel.Definition, ...children: Model.ChildDefinition[]); toElement(omitResources?: boolean, extra?: Record): ClusterElement; static Tag: ElementTag; } export declare namespace ClusterModel { type Definition = Model.Definition & { supportedFeatures?: FeatureSet.Definition; }; type Child = DatatypeModel | AttributeModel | CommandModel | EventModel | FieldModel; /** * A conformant view of {@link ClusterModel} child indices properties. */ class Conformant { #private; constructor(model: ClusterModel); /** * The cluster's conformant attributes. */ get attributes(): ModelIndex; /** * The cluster's conformant properties (includes fields and attributes). * * This offers compatibility with the equivalent field for ValueModel. It is useful when treating a cluster as * a struct. */ get properties(): ModelIndex; /** * The cluster's conformant fields. * * Fields are not formally allowed on clusters but we allow for extensions that should not be served via the * Matter protocol. * * This is primarily here to allow simplified access to fields in contexts where a variable is typed as a * ClusterModel or ValueModel. */ get fields(): ModelIndex; /** * The cluster's conformant commands. */ get commands(): ModelIndex; /** * The cluster's conformant events. */ get events(): ModelIndex; } } //# sourceMappingURL=ClusterModel.d.ts.map