Skip to main content

CoverageRule

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Transform

A single coverage rule: for entities of the given CK type, declare which target attribute paths a DataPointMapping must (or should) cover, plus optionally which child entities must be associated via specific roles.

public record CoverageRule : IEquatable<CoverageRule>

Inheritance ObjectCoverageRule
Implements IEquatable<CoverageRule>

Properties

CkTypeId

The fully qualified CK type id (e.g. "EnergyIQ/Space") this rule applies to. Polymorphic — entities of derived types also match.

public string CkTypeId { get; set; }

Property Value

String

RequiredAttributes

Target attribute paths that MUST be present on at least one enabled mapping inbound to the entity. Missing required attributes produce status="error".

public List<string> RequiredAttributes { get; set; }

Property Value

List<String>

RecommendedAttributes

Target attribute paths that SHOULD be present. Missing recommended attributes produce status="warning" (only relevant when no required attributes are missing).

public List<string> RecommendedAttributes { get; set; }

Property Value

List<String>

RequiredAssociations

Associations that MUST exist from this entity (e.g. a Space must have an associated TemperatureSensor via the EnergyIQ/SpaceSensors role). Missing required associations produce status="error".

Used in v2-style models where measurements live on sensor / actuator entities reached via dedicated association roles, not as inline attributes — the presence of those entities is the actual coverage signal, not a DataPointMapping to an attribute path.

public List<RequiredAssociation> RequiredAssociations { get; set; }

Property Value

List<RequiredAssociation>

Constructors

CoverageRule()

Caution

Constructors of types with required members are not supported in this version of your compiler.


public CoverageRule()