PlacementReport

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1

public class PlacementReport

Summary

Represents a placement report containing validation results and placement data.

This class contains information about a placement operation including validation results, the placeable being placed, and other contextual data.

Metadata

Namespace: GridPlacement.Core.Results

Source File: cs/Core/Results/PlacementReport.cs

Assembly: GridPlacement.Core

Type: class

Constructors

PlacementReport

1
2
3
4
5
6

public PlacementReport(
    IOwner? owner,
    Placeable? placeable,
    CoreVector2I? position,
    ManipulationAction action
)

Initializes a new instance of the PlacementReport class.

Parameters

Properties

Owner

1

public IOwner? Owner { get; }

Gets the owner who performed the placement.

Placeable

1

public Placeable? Placeable { get; }

Gets the placeable being placed.

Placed

1

public Placeable? Placed { get; set; }

Legacy alias used by older workflow code paths.

Position

1

public CoreVector2I? Position { get; }

Gets the position where the placeable is being placed.

Action

1

public ManipulationAction Action { get; }

Gets the manipulation action being performed.

IsSuccessful

1

public bool IsSuccessful { get; set; }

Gets whether the placement is successful.

Issues

1

public List<string> Issues { get; }

Gets the list of placement issues.

StructuredIssues

1

public List<PlacementValidationIssue> StructuredIssues { get; }

IndicatorsReport

1

public IndicatorSetupReport? IndicatorsReport { get; set; }

Optional indicator setup diagnostics associated with this report.

Notes

1

public List<string> Notes { get; }

Supplemental notes for diagnostics.

Methods

AddStructuredIssue

1

public void AddStructuredIssue(PlacementValidationIssue issue)

Adds a structured validation issue to the placement report.

Parameters

AddIssue

1

public void AddIssue(string issue)

Adds an issue to the placement report.

Parameters

GetIssues

1

public List<string> GetIssues()

Gets all placement issues.

Returns

A list of placement issues.

AddNote

1

public void AddNote(string note)

IsFailed

1

public bool IsFailed()

ToVerboseString

1

public string ToVerboseString()