SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::discretization::domain::schema::validation::SchemaRelationValidationResult Struct Reference

The result of validating a single relation against a mesh. More...

#include <results.hpp>

Collaboration diagram for serif::discretization::domain::schema::validation::SchemaRelationValidationResult:
[legend]

Public Member Functions

bool valid () const noexcept
 Check if the relation validation was successful.
 
 operator bool () const noexcept
 Check if the relation validation was successful (explicit conversion to bool).
 

Public Attributes

std::size_t relationIndex {0}
 The index of the relation in the schema's relation list.
 
std::string_view relationName
 The name of the relation being validated.
 
relation::validation::RelationValidationResult result
 The result of validating the relation against the mesh.
 

Detailed Description

The result of validating a single relation against a mesh.

Member Function Documentation

◆ operator bool()

serif::discretization::domain::schema::validation::SchemaRelationValidationResult::operator bool ( ) const
explicitnodiscardnoexcept

Check if the relation validation was successful (explicit conversion to bool).

◆ valid()

bool serif::discretization::domain::schema::validation::SchemaRelationValidationResult::valid ( ) const
nodiscardnoexcept

Check if the relation validation was successful.

Member Data Documentation

◆ relationIndex

std::size_t serif::discretization::domain::schema::validation::SchemaRelationValidationResult::relationIndex {0}

The index of the relation in the schema's relation list.

◆ relationName

std::string_view serif::discretization::domain::schema::validation::SchemaRelationValidationResult::relationName

The name of the relation being validated.

◆ result

relation::validation::RelationValidationResult serif::discretization::domain::schema::validation::SchemaRelationValidationResult::result

The result of validating the relation against the mesh.


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