serif::discretization::domain::schema::validation::SchemaValidationResult Struct Reference

The result of validating a schema against a mesh. More...

#include <results.hpp>

Collaboration diagram for serif::discretization::domain::schema::validation::SchemaValidationResult:

Public Member Functions
bool	valid () const noexcept
	Check if all relations in the schema validation were successful.
	operator bool () const noexcept
	Check if all relations in the schema validation were successful (explicit conversion to bool).
std::size_t	relation_count () const noexcept
	Get the total number of relations in the schema.
std::size_t	failed_relation_count () const noexcept
	Get the number of relations that failed validation.
std::size_t	passed_relation_count () const noexcept
	Get the number of relations that passed validation.
std::optional< std::size_t >	first_failed_relation_index () const noexcept
	Get the index of the first failed relation, if any.

Public Attributes
std::vector< SchemaRelationValidationResult >	relationResults
	The results of validating each relation in the schema.

Detailed Description

The result of validating a schema against a mesh.

Member Function Documentation

failed_relation_count()

std::size_t serif::discretization::domain::schema::validation::SchemaValidationResult::failed_relation_count ( ) const

nodiscardnoexcept

Get the number of relations that failed validation.

first_failed_relation_index()

std::optional< std::size_t > serif::discretization::domain::schema::validation::SchemaValidationResult::first_failed_relation_index ( ) const

nodiscardnoexcept

Get the index of the first failed relation, if any.

operator bool()

serif::discretization::domain::schema::validation::SchemaValidationResult::operator bool ( ) const

explicitnodiscardnoexcept

Check if all relations in the schema validation were successful (explicit conversion to bool).

passed_relation_count()

std::size_t serif::discretization::domain::schema::validation::SchemaValidationResult::passed_relation_count ( ) const

nodiscardnoexcept

Get the number of relations that passed validation.

relation_count()

std::size_t serif::discretization::domain::schema::validation::SchemaValidationResult::relation_count ( ) const

nodiscardnoexcept

Get the total number of relations in the schema.

valid()

bool serif::discretization::domain::schema::validation::SchemaValidationResult::valid ( ) const

nodiscardnoexcept

Check if all relations in the schema validation were successful.

Member Data Documentation

relationResults

std::vector<SchemaRelationValidationResult> serif::discretization::domain::schema::validation::SchemaValidationResult::relationResults

The results of validating each relation in the schema.

---

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

• src/include/serif/discretization/domain/schema/validation/results.hpp
• src/lib/serif/discretization/domain/schema/validation/results.cpp