Zum Hauptinhalt springen

ValidateDataPointCoverageNodeConfiguration

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Transform

Configuration for the ValidateDataPointCoverage node. Traverses a tree hierarchy (root + children via the configured ParentChild role) and for every visited node evaluates which target attribute paths are covered by inbound DataPointMappings. Emits a JSON report at TargetPath that can be persisted via the SetPipelineExecutionResult@1 node so the Studio can colour-code the tree.

public record ValidateDataPointCoverageNodeConfiguration : TargetPathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<ValidateDataPointCoverageNodeConfiguration>

Inheritance Object → NodeConfiguration → TargetPathNodeConfiguration → ValidateDataPointCoverageNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<ValidateDataPointCoverageNodeConfiguration>

Properties​

Identity​

Identity this node runs as: Caller (default), ServiceAccount (the pipeline's service account with its full roles, even when a caller is present), or System (unfiltered, bypasses data permissions). A missing value resolves to Caller so existing pipelines are unchanged (AB#5127).

public NodeExecutionIdentity Identity { get; set; }

Property Value​

NodeExecutionIdentity

RootRtId​

RtId of the tree root entity to validate. Leave empty to read from the data context at ValidateDataPointCoverageNodeConfiguration.RootRtIdPath.

public string RootRtId { get; set; }

Property Value​

String

RootCkTypeId​

CK type id of the root entity (e.g. "Basic/Tree" or a derived type). Required.

public string RootCkTypeId { get; set; }

Property Value​

String

RootRtIdPath​

Optional JsonPath in the data context to read the root rtId from when ValidateDataPointCoverageNodeConfiguration.RootRtId is empty.

public string RootRtIdPath { get; set; }

Property Value​

String

ChildRoleId​

Association role used to traverse parent→child relationships. The query uses INBOUND direction on the parent: children are entities whose outbound ParentChild points at the parent. Defaults to System/ParentChild.

public string ChildRoleId { get; set; }

Property Value​

String

ChildCkTypeId​

CK type id of children to traverse (polymorphic; e.g. "Basic/TreeNode"). Defaults to Basic/TreeNode.

public string ChildCkTypeId { get; set; }

Property Value​

String

MaxDepth​

Maximum depth to traverse from the root (1 = only direct children). Defaults to a generous value that handles normal building hierarchies.

public int MaxDepth { get; set; }

Property Value​

Int32

AdditionalChildRoleIds​

Additional association roles traversed INBOUND at every node besides ValidateDataPointCoverageNodeConfiguration.ChildRoleId — e.g. "EnergyIQ/SpaceSensors" or "EnergyIQ/SpaceTerminals" in v2-style models where measurements live on device entities (sensors / actuators / terminals) attached to a Space via dedicated roles. Entities reached this way become report nodes of their own, so per-type ValidateDataPointCoverageNodeConfiguration.Rules (e.g. TemperatureSensor requires a CurrentValue mapping) apply to them and the Studio coverage tree — which surfaces the same entities via association auto-discovery — can show their status. Empty by default (spatial hierarchy only).

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

Property Value​

List<String>

MappingRoleId​

Association role used to find DataPointMappings pointing at a node. Defaults to System.Communication/MapsTo.

public string MappingRoleId { get; set; }

Property Value​

String

MappingCkTypeId​

CK type id of mapping entities (polymorphic). Defaults to System.Communication/DataPointMapping.

public string MappingCkTypeId { get; set; }

Property Value​

String

IncludeDisabledMappings​

Whether disabled DataPointMappings (Enabled=false) contribute to coverage. Defaults to false — disabled mappings do not count.

public bool IncludeDisabledMappings { get; set; }

Property Value​

Boolean

Rules​

Coverage rules per CK type. Entities not covered by any rule receive status="info" with empty missing/present lists.

public List<CoverageRule> Rules { get; set; }

Property Value​

List<CoverageRule>

TargetPath​

public string TargetPath { get; set; }

Property Value​

String

TargetValueWriteMode​

public TargetValueWriteModes TargetValueWriteMode { get; set; }

Property Value​

TargetValueWriteModes

TargetValueKind​

public ValueKinds TargetValueKind { get; set; }

Property Value​

ValueKinds

DocumentMode​

public DocumentModes DocumentMode { get; set; }

Property Value​

DocumentModes

Description​

public string Description { get; set; }

Property Value​

String

Constructors​

ValidateDataPointCoverageNodeConfiguration()​

Caution​

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


public ValidateDataPointCoverageNodeConfiguration()