Program Listing for File EdgeFrameToFrame.h

↰ Return to documentation for file (include/Karana/Frame/EdgeFrameToFrame.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.
 */

/**
 * @file
 * @brief Contains the declarations for the EdgeFrameToFrame class.
 */

#pragma once

#include "Karana/Frame/FrameToFrame.h"
#include "Karana/KCore/Base.h"
#include <string>

namespace Karana::Frame {

    namespace kc = Karana::Core;

    class FrameContainer;
    class Frame;

    /**
     * @class EdgeFrameToFrame
     * @brief Base class for an edge FrameToFrame in the frames tree
     *
     * See \sref{frames_layer_sec} for more discussion on
     * the frames layer.
     */
    class EdgeFrameToFrame : public FrameToFrame {

      public:
        /**
         * @brief EdgeFrameToFrame destructor.
         */
        virtual ~EdgeFrameToFrame();

      public:
        /**
         * @brief Constructor for EdgeFrameToFrame.
         * @param oframe oframe of the EdgeFrameToFrame.
         * @param pframe pframe of the EdgeFrameToFrame.
         * @param name for the edge
         */
        EdgeFrameToFrame(const kc::ks_ptr<Frame> &oframe,
                         const kc::ks_ptr<Frame> &pframe,
                         std::string_view name = "");

      protected:
        /**
         * @brief Discard the provided EdgeFrameToFrame.
         * @param base - Base pointer to the EdgeFrameToFrame to discard.
         */
        void _discard(kc::ks_ptr<Base> &base) override;
    };

} // namespace Karana::Frame