Program Listing for File Defs.h

↰ Return to documentation for file (include/Karana/RequirementsTest/Defs.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

// Written by Codex for kelly on 2026-08-17.
/**
 * @file
 * @brief Defines stable value types shared by requirement catalogs and logging.
 */

#pragma once

#include <stdexcept>
#include <string>
#include <string_view>

namespace RequirementsTest {

    /** @brief Requirement verification outcome recorded in the process artifact. */
    enum class Status {
        /** The requirement was satisfied. */
        PASSED,
        /** The requirement was not satisfied. */
        FAILED,
        /** The requirement was intentionally not verified. */
        SKIPPED
    };

    /** @brief Type-safe authored requirement identifier. */
    struct Requirement {
        /**
         * @brief Construct an owning requirement identifier.
         * @param uid_value Fully qualified authored requirement UID.
         * @throws std::invalid_argument If the UID is empty.
         */
        explicit Requirement(std::string_view uid_value)
            : uid(uid_value) {
            // Empty identifiers can never refer to authored requirements.
            if (uid.empty()) {
                throw std::invalid_argument("Requirement UID cannot be empty");
            }
        }

        /// Fully qualified requirement UID.
        std::string uid;
    };

} // namespace RequirementsTest