GraphContainer.h

Go to the documentation of this file.

//-
// ================================================================================================
// Copyright 2024 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license agreement provided
// at the time of installation or download, or which otherwise accompanies this software in
// either electronic or hard copy form.
// ================================================================================================
//+
 
 
#ifndef BIFROSTGRAPH_EXECUTOR_GRAPHCONTAINER_H
#define BIFROSTGRAPH_EXECUTOR_GRAPHCONTAINER_H
 
#include <BifrostGraph/Executor/Factory.h>
#include <BifrostGraph/Executor/Owner.h>
#include <BifrostGraph/Executor/Types.h>
 
#include <BifrostGraph/Executor/internal/ExecutorExport.h>
#include <BifrostGraph/Executor/internal/PropagateConstPtr.h>
 
#include <Amino/Core/String.h>
 
//-------------------------------------------------------------------------------------------------
// Forward declarations
//-------------------------------------------------------------------------------------------------
 
namespace BifrostGraph {
namespace Executor {
 
class Job;
class Workspace;
 
namespace Private {
class GraphContainerImpl;
class JobImpl;
class IGraphContainerOwner;
class IRestrictedGraphContainerServices;
} // namespace Private
 
 
//-------------------------------------------------------------------------------------------------
// CLASS GraphContainer
//-------------------------------------------------------------------------------------------------
 
class BIFROSTGRAPH_EXECUTOR_SHARED_DECL GraphContainer {
protected:
    //---------------------------------------------------------------------------------------------
    // Initialization
    //---------------------------------------------------------------------------------------------
 
    explicit GraphContainer(Private::IGraphContainerOwner& owner) noexcept;
 
    explicit GraphContainer(Uninitialized uninitialized) noexcept;
 
    EXECUTOR_DECLARE_MAKE_OWNER_FRIENDSHIP();
 
    struct SetGraphInfo;
 
public:
    virtual ~GraphContainer() noexcept;
 
    virtual bool isValid() const noexcept;
 
    static GraphContainer& getInvalid() noexcept;
 
    const Workspace& getWorkspace() const noexcept;
    Workspace&       getWorkspace() noexcept;
 
    //---------------------------------------------------------------------------------------------
    // Graph Management
    //---------------------------------------------------------------------------------------------
 
    bool setGraph(const Amino::String& name, SetGraphMode mode = SetGraphMode::kDefault) noexcept;
 
    Amino::String getGraphName() const noexcept;
 
    Amino::String getGraphQualifiedName() const noexcept;
 
    GraphCompilationStatus compile(GraphCompilationMode mode) noexcept;
 
    //---------------------------------------------------------------------------------------------
    // Job Management
    //---------------------------------------------------------------------------------------------
 
    const Job& getJob() const noexcept;
    Job&       getJob() noexcept;
 
protected:
    void reportMessage(MessageCategory category, const Amino::String& message) const noexcept;
 
    struct SetGraphInfo {
        Amino::String name;          
        Amino::String qualifiedName; 
        Amino::String filePath;      
        SetGraphMode mode;           
    };
 
private:
    friend class Private::GraphContainerImpl;
 
    virtual void onBeginSetGraph(const SetGraphInfo& graphInfo) noexcept;
 
    virtual void onEndSetGraph(const SetGraphInfo& graphInfo) noexcept;
 
    virtual void onBeginCompileGraph() noexcept;
 
    virtual void onEndCompileGraph(GraphCompilationStatus status) noexcept;
 
public:
    //---------------------------------------------------------------------------------------------
    // IRestrictedGraphContainerServices
    //---------------------------------------------------------------------------------------------
 
    const Private::IRestrictedGraphContainerServices& getRestrictedServices() const noexcept;
    Private::IRestrictedGraphContainerServices&       getRestrictedServices() noexcept;
 
private:
    GraphContainer(const GraphContainer&)            = delete;
    GraphContainer(GraphContainer&&)                 = delete;
    GraphContainer& operator=(const GraphContainer&) = delete;
    GraphContainer& operator=(GraphContainer&&)      = delete;
 
private:
    Internal::PropagateConstPtr<Private::GraphContainerImpl, Internal::Owned::kYes> m_impl;
    static GraphContainer                                                           s_invalid;
};
 
} // namespace Executor
} // namespace BifrostGraph
 
#endif // BIFROSTGRAPH_EXECUTOR_GRAPHCONTAINER_H