ra2ce.common.validation package

Submodules

ra2ce.common.validation.ra2ce_validator_protocol module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class Ra2ceIoValidator(*args, **kwargs)

Bases: Protocol

validate()

Generates a ValidationReport based on its inner-defined criteria.

Return type:

ValidationReport

Returns:

ValidationReport: Result of the internal checks.

ra2ce.common.validation.validation_report module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class ValidationReport

Bases: object

error(error_mssg)

Return type:

None

Parameters:

error_mssg (str)

is_valid()

Return type:

bool

merge(with_report)

Merges a given report with the current one.

Return type:

None

Parameters:

with_report (Any)

Args:

with_report (Any): ValidationReport that will be merged.

warn(warn_mssg)

Return type:

None

Parameters:

warn_mssg (str)

Module contents