Loading...
Searching...
No Matches
meshkit::plan::ConstraintAuditReport Struct Reference

Result of auditConstraintSimplification() or auditMeshConstraints(). More...

#include <meshkit/constraintaudit.hpp>

Collaboration diagram for meshkit::plan::ConstraintAuditReport:

Public Attributes

bool ok = false
 complete and no violations: the only state that certifies the input.
 
bool complete = false
 Not cancelled and not resource-limited.
 
bool cancelled = false
 ConstraintAuditOptions::cancelled stopped the audit.
 
bool resourceLimited = false
 The work budget or workspace estimate ran out.
 
Text error
 Empty when no violation was found and the audit finished; otherwise "<id>: <message>" of the first violation, or the cancellation / resource-limit message.
 
std::uint64_t featuresChecked = 0
 Features examined (simplification audit), or required features examined (mesh audit).
 
std::uint64_t segmentsChecked = 0
 Output segments (simplification audit) or required source segments (mesh audit) examined.
 
std::uint64_t cellsChecked = 0
 Delivered cells visited; mesh audit only.
 
std::uint64_t violations = 0
 Total violations found, including those beyond maximumExamples.
 
std::uint64_t workUsed = 0
 Work units consumed.
 
double maximumXYDeviation = 0
 Largest XY distance found: of a removed vertex from its output shortcut (simplification audit), or of a matched delivered edge from its source line (mesh audit).
 
double maximumZDeviation = 0
 Largest Z difference found, in Z units: of a removed vertex from linear interpolation, or of a delivered endpoint from its authored elevation.
 
double maximumAreaChange = 0
 Largest absolute ring area change in squared XY units; simplification audit only.
 
double coordinateRoundoff = 0
 Largest XY matching tolerance used, 32 machine epsilons times the segment's coordinate scale; mesh audit only.
 
Vector< ConstraintAuditExample > examples
 First violations, at most maximumExamples (clamped to [0, 1000]).
 

Detailed Description

Member Data Documentation

◆ cancelled

bool meshkit::plan::ConstraintAuditReport::cancelled = false

◆ cellsChecked

std::uint64_t meshkit::plan::ConstraintAuditReport::cellsChecked = 0

Delivered cells visited; mesh audit only.

◆ complete

bool meshkit::plan::ConstraintAuditReport::complete = false

Not cancelled and not resource-limited.

Structural violations can still end the audit early with complete set.

◆ coordinateRoundoff

double meshkit::plan::ConstraintAuditReport::coordinateRoundoff = 0

Largest XY matching tolerance used, 32 machine epsilons times the segment's coordinate scale; mesh audit only.

◆ error

Text meshkit::plan::ConstraintAuditReport::error

Empty when no violation was found and the audit finished; otherwise "<id>: <message>" of the first violation, or the cancellation / resource-limit message.

◆ examples

Vector<ConstraintAuditExample> meshkit::plan::ConstraintAuditReport::examples

First violations, at most maximumExamples (clamped to [0, 1000]).

◆ featuresChecked

std::uint64_t meshkit::plan::ConstraintAuditReport::featuresChecked = 0

Features examined (simplification audit), or required features examined (mesh audit).

◆ maximumAreaChange

double meshkit::plan::ConstraintAuditReport::maximumAreaChange = 0

Largest absolute ring area change in squared XY units; simplification audit only.

◆ maximumXYDeviation

double meshkit::plan::ConstraintAuditReport::maximumXYDeviation = 0

Largest XY distance found: of a removed vertex from its output shortcut (simplification audit), or of a matched delivered edge from its source line (mesh audit).

◆ maximumZDeviation

double meshkit::plan::ConstraintAuditReport::maximumZDeviation = 0

Largest Z difference found, in Z units: of a removed vertex from linear interpolation, or of a delivered endpoint from its authored elevation.

◆ ok

bool meshkit::plan::ConstraintAuditReport::ok = false

complete and no violations: the only state that certifies the input.

◆ resourceLimited

bool meshkit::plan::ConstraintAuditReport::resourceLimited = false

The work budget or workspace estimate ran out.

◆ segmentsChecked

std::uint64_t meshkit::plan::ConstraintAuditReport::segmentsChecked = 0

Output segments (simplification audit) or required source segments (mesh audit) examined.

◆ violations

std::uint64_t meshkit::plan::ConstraintAuditReport::violations = 0

Total violations found, including those beyond maximumExamples.

◆ workUsed

std::uint64_t meshkit::plan::ConstraintAuditReport::workUsed = 0

Work units consumed.


The documentation for this struct was generated from the following file: