PACS System 0.1.0
PACS DICOM system library
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
kcenon::pacs::services::validation::validation_result Struct Reference

Result of IOD validation. More...

#include <us_iod_validator.h>

Collaboration diagram for kcenon::pacs::services::validation::validation_result:
Collaboration graph

Public Member Functions

bool has_errors () const noexcept
 Check if there are any errors.
 
bool has_warnings () const noexcept
 Check if there are any warnings.
 
size_t error_count () const noexcept
 Get count of errors.
 
size_t warning_count () const noexcept
 Get count of warnings.
 
std::string summary () const
 Get a formatted summary string.
 

Public Attributes

bool is_valid
 Overall validation status.
 
std::vector< validation_finding > findings
 All findings during validation.
 

Detailed Description

Result of IOD validation.

Definition at line 58 of file us_iod_validator.h.

Member Function Documentation

◆ error_count()

size_t kcenon::pacs::services::validation::validation_result::error_count ( ) const
nodiscardnoexcept

Get count of errors.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 42 of file us_iod_validator.cpp.

42 {
43 size_t count = 0;
44 for (const auto& f : findings) {
45 if (f.severity == validation_severity::error) {
46 ++count;
47 }
48 }
49 return count;
50}
kcenon::pacs::services::validation::validation_result::findings
std::vector< validation_finding > findings
All findings during validation.
Definition us_iod_validator.h:60

References kcenon::pacs::services::validation::error, and findings.

Referenced by summary().

Here is the caller graph for this function:

◆ has_errors()

bool kcenon::pacs::services::validation::validation_result::has_errors ( ) const
nodiscardnoexcept

Check if there are any errors.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 24 of file us_iod_validator.cpp.

24 {
25 for (const auto& f : findings) {
26 if (f.severity == validation_severity::error) {
27 return true;
28 }
29 }
30 return false;
31}

References kcenon::pacs::services::validation::error, and findings.

◆ has_warnings()

bool kcenon::pacs::services::validation::validation_result::has_warnings ( ) const
nodiscardnoexcept

Check if there are any warnings.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 33 of file us_iod_validator.cpp.

33 {
34 for (const auto& f : findings) {
35 if (f.severity == validation_severity::warning) {
36 return true;
37 }
38 }
39 return false;
40}
kcenon::pacs::services::validation::validation_severity::warning
@ warning
Non-critical - IOD may have issues.

References findings, and kcenon::pacs::services::validation::warning.

◆ summary()

std::string kcenon::pacs::services::validation::validation_result::summary ( ) const
nodiscard

Get a formatted summary string.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 62 of file us_iod_validator.cpp.

62 {
63 std::ostringstream oss;
64 oss << "Validation " << (is_valid ? "PASSED" : "FAILED");
65 oss << " - " << error_count() << " error(s), "
66 << warning_count() << " warning(s)";
67 return oss.str();
68}
kcenon::pacs::services::validation::validation_result::error_count
size_t error_count() const noexcept
Get count of errors.
Definition us_iod_validator.cpp:42
kcenon::pacs::services::validation::validation_result::is_valid
bool is_valid
Overall validation status.
Definition us_iod_validator.h:59
kcenon::pacs::services::validation::validation_result::warning_count
size_t warning_count() const noexcept
Get count of warnings.
Definition us_iod_validator.cpp:52

References error_count(), is_valid, and warning_count().

Here is the call graph for this function:

◆ warning_count()

size_t kcenon::pacs::services::validation::validation_result::warning_count ( ) const
nodiscardnoexcept

Get count of warnings.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 52 of file us_iod_validator.cpp.

52 {
53 size_t count = 0;
54 for (const auto& f : findings) {
55 if (f.severity == validation_severity::warning) {
56 ++count;
57 }
58 }
59 return count;
60}

References findings, and kcenon::pacs::services::validation::warning.

Referenced by summary().

Here is the caller graph for this function:

Member Data Documentation

◆ findings

std::vector<validation_finding> kcenon::pacs::services::validation::validation_result::findings

All findings during validation.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 60 of file us_iod_validator.h.

Referenced by kcenon::pacs::services::validation::waveform_ps_iod_validator::check_type1_attribute(), kcenon::pacs::services::validation::waveform_ps_iod_validator::check_type2_attribute(), error_count(), has_errors(), has_warnings(), kcenon::pacs::services::validation::ct_iod_validator::validate(), kcenon::pacs::services::validation::ct_processing_iod_validator::validate(), kcenon::pacs::services::validation::dx_iod_validator::validate(), kcenon::pacs::services::validation::heightmap_seg_iod_validator::validate(), kcenon::pacs::services::validation::label_map_seg_iod_validator::validate(), kcenon::pacs::services::validation::mg_iod_validator::validate(), kcenon::pacs::services::validation::mr_iod_validator::validate(), kcenon::pacs::services::validation::nm_iod_validator::validate(), kcenon::pacs::services::validation::ophthalmic_iod_validator::validate(), kcenon::pacs::services::validation::parametric_map_iod_validator::validate(), kcenon::pacs::services::validation::pet_iod_validator::validate(), kcenon::pacs::services::validation::rt_dose_iod_validator::validate(), kcenon::pacs::services::validation::rt_iod_validator::validate(), kcenon::pacs::services::validation::rt_plan_iod_validator::validate(), kcenon::pacs::services::validation::rt_structure_set_iod_validator::validate(), kcenon::pacs::services::validation::seg_iod_validator::validate(), kcenon::pacs::services::validation::sr_iod_validator::validate(), kcenon::pacs::services::validation::us_iod_validator::validate(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate(), kcenon::pacs::services::validation::wsi_iod_validator::validate(), kcenon::pacs::services::validation::xa_iod_validator::validate(), kcenon::pacs::services::validation::sr_iod_validator::validate_basic_text_sr(), kcenon::pacs::services::validation::xa_iod_validator::validate_calibration(), kcenon::pacs::services::validation::sr_iod_validator::validate_comprehensive_sr(), kcenon::pacs::services::validation::mg_iod_validator::validate_compression_force(), kcenon::pacs::services::validation::sr_iod_validator::validate_content_tree(), kcenon::pacs::services::validation::sr_iod_validator::validate_enhanced_sr(), kcenon::pacs::services::validation::sr_iod_validator::validate_key_object_selection(), kcenon::pacs::services::validation::mg_iod_validator::validate_laterality(), kcenon::pacs::services::validation::seg_iod_validator::validate_references(), kcenon::pacs::services::validation::sr_iod_validator::validate_references(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate_references(), kcenon::pacs::services::validation::heightmap_seg_iod_validator::validate_segments(), kcenon::pacs::services::validation::label_map_seg_iod_validator::validate_segments(), kcenon::pacs::services::validation::seg_iod_validator::validate_segments(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate_sop_common_module(), kcenon::pacs::services::validation::mg_iod_validator::validate_view_position(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate_waveform_annotation_module(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate_waveform_ps_module(), and warning_count().

◆ is_valid

bool kcenon::pacs::services::validation::validation_result::is_valid

Overall validation status.

Examples
/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/services/validation/us_iod_validator.h.

Definition at line 59 of file us_iod_validator.h.

Referenced by summary(), kcenon::pacs::services::validation::ct_iod_validator::validate(), kcenon::pacs::services::validation::ct_processing_iod_validator::validate(), kcenon::pacs::services::validation::dx_iod_validator::validate(), kcenon::pacs::services::validation::heightmap_seg_iod_validator::validate(), kcenon::pacs::services::validation::label_map_seg_iod_validator::validate(), kcenon::pacs::services::validation::mg_iod_validator::validate(), kcenon::pacs::services::validation::mr_iod_validator::validate(), kcenon::pacs::services::validation::nm_iod_validator::validate(), kcenon::pacs::services::validation::ophthalmic_iod_validator::validate(), kcenon::pacs::services::validation::parametric_map_iod_validator::validate(), kcenon::pacs::services::validation::pet_iod_validator::validate(), kcenon::pacs::services::validation::rt_dose_iod_validator::validate(), kcenon::pacs::services::validation::rt_iod_validator::validate(), kcenon::pacs::services::validation::rt_plan_iod_validator::validate(), kcenon::pacs::services::validation::rt_structure_set_iod_validator::validate(), kcenon::pacs::services::validation::seg_iod_validator::validate(), kcenon::pacs::services::validation::sr_iod_validator::validate(), kcenon::pacs::services::validation::us_iod_validator::validate(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate(), kcenon::pacs::services::validation::wsi_iod_validator::validate(), kcenon::pacs::services::validation::xa_iod_validator::validate(), kcenon::pacs::services::validation::sr_iod_validator::validate_basic_text_sr(), kcenon::pacs::services::validation::xa_iod_validator::validate_calibration(), kcenon::pacs::services::validation::sr_iod_validator::validate_comprehensive_sr(), kcenon::pacs::services::validation::mg_iod_validator::validate_compression_force(), kcenon::pacs::services::validation::sr_iod_validator::validate_content_tree(), kcenon::pacs::services::validation::sr_iod_validator::validate_enhanced_sr(), kcenon::pacs::services::validation::sr_iod_validator::validate_key_object_selection(), kcenon::pacs::services::validation::mg_iod_validator::validate_laterality(), kcenon::pacs::services::validation::seg_iod_validator::validate_references(), kcenon::pacs::services::validation::sr_iod_validator::validate_references(), kcenon::pacs::services::validation::waveform_ps_iod_validator::validate_references(), kcenon::pacs::services::validation::heightmap_seg_iod_validator::validate_segments(), kcenon::pacs::services::validation::label_map_seg_iod_validator::validate_segments(), kcenon::pacs::services::validation::seg_iod_validator::validate_segments(), and kcenon::pacs::services::validation::mg_iod_validator::validate_view_position().

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