TypeTranslation.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_TYPE_TRANSLATION_H
#define BIFROSTGRAPH_EXECUTOR_TYPE_TRANSLATION_H
 
#include <BifrostGraph/Executor/internal/ExecutorExport.h>
 
#include <BifrostGraph/Executor/Types.h>
 
#include <Amino/Core/Array.h>
#include <Amino/Core/String.h>
 
namespace Amino {
class Any;
class Library;
class Metadata;
class Type;
class Value;
 
template <typename E>
class EntityIndexedList;
 
typedef EntityIndexedList<const Type> TypeConstIndexedList;
} // namespace Amino
 
namespace BifrostGraph {
namespace Executor {
 
 
class BIFROSTGRAPH_EXECUTOR_SHARED_DECL TypeTranslation {
public:
    using String      = Amino::String;
    using StringArray = Amino::Array<String>;
 
    class BIFROSTGRAPH_EXECUTOR_SHARED_DECL ValueData {
    public:
        ValueData() noexcept;
        virtual ~ValueData() noexcept;
    };
 
    class BIFROSTGRAPH_EXECUTOR_SHARED_DECL PortData {
    public:
        PortData() noexcept;
        virtual ~PortData() noexcept;
    };
 
    class BIFROSTGRAPH_EXECUTOR_SHARED_DECL PluginHostData {
    public:
        PluginHostData() noexcept;
        virtual ~PluginHostData() noexcept;
    };
 
public:
    explicit TypeTranslation(String name) noexcept;
 
    virtual ~TypeTranslation() noexcept;
 
    String getName() const noexcept;
 
    using CreateFunc = TypeTranslation* (*)();
 
    static const char* createFuncName() noexcept;
 
    virtual void deleteThis() noexcept = 0;
 
    virtual void getSupportedTypes(const Amino::Library&        amLibrary,
                                   Amino::TypeConstIndexedList& types) const noexcept;
 
    virtual void getSupportedTypeNames(StringArray& names) const noexcept;
 
    virtual bool convertValueFromHost(const Amino::Type& type,
                                      Amino::Any&        any,
                                      const ValueData*   valueData) const noexcept;
 
    virtual bool convertValueToHost(const Amino::Any& any, ValueData* valueData) const noexcept;
 
    virtual bool portAdded(const String&          name,
                           PortDirection          direction,
                           const Amino::Type&     type,
                           const Amino::Metadata& metadata,
                           PortClass              portClass,
                           PortData*              portData) const noexcept;
 
    virtual bool portRemoved(const String& name, const String& graphName) const noexcept;
 
    virtual bool portRenamed(const String& prevName,
                             const String& name,
                             const String& graphName) const noexcept;
 
    virtual bool registerHostPlugins(const PluginHostData* pluginData) const noexcept;
 
    virtual bool unregisterHostPlugins(const PluginHostData* pluginData) const noexcept;
 
private:
    TypeTranslation(const TypeTranslation&)             = delete;
    TypeTranslation(TypeTranslation&&)                  = delete;
    TypeTranslation& operator=(const TypeTranslation&)  = delete;
    TypeTranslation& operator=(TypeTranslation&&)       = delete;
 
    String m_name;
};
 
} // namespace Executor
} // namespace BifrostGraph
#endif