MorphologicalAttributeFilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmcfilters::TreeValidationResult Struct Reference

Non-throwing validation result returned by edit-session checks. More...

#include <MorphologicalTree.hpp>

Public Member Functions

 operator bool () const noexcept
 Allows validation results to be tested directly in boolean contexts.
 

Public Attributes

bool ok = false
 True when the checked tree topology satisfies the validation contract.
 
std::string message
 Human-readable diagnostic, especially useful when ok is false.
 

Detailed Description

Non-throwing validation result returned by edit-session checks.

ok carries the success flag and message carries a diagnostic when validation fails. The explicit boolean conversion mirrors ok so callers can write compact checks while still preserving the detailed message.

Definition at line 72 of file MorphologicalTree.hpp.

Member Function Documentation

◆ operator bool()

mmcfilters::TreeValidationResult::operator bool ( ) const
inlineexplicitnoexcept

Allows validation results to be tested directly in boolean contexts.

Definition at line 82 of file MorphologicalTree.hpp.

Member Data Documentation

◆ message

std::string mmcfilters::TreeValidationResult::message

Human-readable diagnostic, especially useful when ok is false.

Definition at line 77 of file MorphologicalTree.hpp.

◆ ok

bool mmcfilters::TreeValidationResult::ok = false

True when the checked tree topology satisfies the validation contract.

Definition at line 74 of file MorphologicalTree.hpp.


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