Icarus
Vehicle Simulation as a Transformable Computational Graph, built on Vulcan and Janus
Loading...
Searching...
No Matches
icarus::ValidationResult Class Reference

Structured validation result with errors and warnings. More...

#include <ValidationResult.hpp>

Public Member Functions

 ValidationResult ()=default
bool IsValid () const
 Check if validation passed (no errors).
std::vector< std::string > GetErrors () const
 Get all error messages.
std::vector< std::string > GetWarnings () const
 Get all warning messages.
std::vector< std::string > GetInfos () const
 Get all info messages.
const std::vector< ValidationIssue > & GetIssues () const
 Get all issues.
void AddError (const std::string &message, const std::string &context="")
 Add an error.
void AddWarning (const std::string &message, const std::string &context="")
 Add a warning.
void AddInfo (const std::string &message, const std::string &context="")
 Add an info message.
bool HasIssues () const
 Check if there are any issues at all.
size_t ErrorCount () const
 Get error count.
size_t WarningCount () const
 Get warning count.

Detailed Description

Structured validation result with errors and warnings.

Used for recording validation before warmstart and other validation checks.

Example:

ValidationResult result = sim->ValidateRecording("flight.h5");
if (!result.IsValid()) {
for (const auto& error : result.GetErrors()) {
std::cerr << "Error: " << error << std::endl;
}
throw WarmstartError("Recording incompatible");
}
for (const auto& warning : result.GetWarnings()) {
std::cerr << "Warning: " << warning << std::endl;
}
std::vector< std::string > GetErrors() const
Get all error messages.
Definition ValidationResult.hpp:73
bool IsValid() const
Check if validation passed (no errors).
Definition ValidationResult.hpp:63
std::vector< std::string > GetWarnings() const
Get all warning messages.
Definition ValidationResult.hpp:84

Constructor & Destructor Documentation

◆ ValidationResult()

icarus::ValidationResult::ValidationResult ( )
default

Member Function Documentation

◆ AddError()

void icarus::ValidationResult::AddError ( const std::string & message,
const std::string & context = "" )
inline

Add an error.

◆ AddInfo()

void icarus::ValidationResult::AddInfo ( const std::string & message,
const std::string & context = "" )
inline

Add an info message.

◆ AddWarning()

void icarus::ValidationResult::AddWarning ( const std::string & message,
const std::string & context = "" )
inline

Add a warning.

◆ ErrorCount()

size_t icarus::ValidationResult::ErrorCount ( ) const
inlinenodiscard

Get error count.

◆ GetErrors()

std::vector< std::string > icarus::ValidationResult::GetErrors ( ) const
inlinenodiscard

Get all error messages.

◆ GetInfos()

std::vector< std::string > icarus::ValidationResult::GetInfos ( ) const
inlinenodiscard

Get all info messages.

◆ GetIssues()

const std::vector< ValidationIssue > & icarus::ValidationResult::GetIssues ( ) const
inlinenodiscard

Get all issues.

◆ GetWarnings()

std::vector< std::string > icarus::ValidationResult::GetWarnings ( ) const
inlinenodiscard

Get all warning messages.

◆ HasIssues()

bool icarus::ValidationResult::HasIssues ( ) const
inlinenodiscard

Check if there are any issues at all.

◆ IsValid()

bool icarus::ValidationResult::IsValid ( ) const
inlinenodiscard

Check if validation passed (no errors).

◆ WarningCount()

size_t icarus::ValidationResult::WarningCount ( ) const
inlinenodiscard

Get warning count.


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