gpu_context_helpers.hpp

Go to the documentation of this file.

// Copyright (C) 2018-2020 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
//

/**
 * @brief a header that defines helpers for GPU plugin-specific wrappers
 *
 * @file gpu_context_helpers.hpp
 */
#pragma once

#include <string>

namespace InferenceEngine {

namespace gpu {

namespace details {
/**
* @brief This wrapper class is used to obtain low-level handles
* from remote blob or context object parameters.
*/
class param_map_obj_getter {
protected:
    /**
    * @brief Template function that returns specified
    * object parameter typecasted to desired user type
    */
    template <typename Result, typename Tmp>
    Result _ObjFromParams(const ParamMap& params,
        const std::string& handle_Key,
        const std::string& type_Key,
        const std::string& obj_T1,
        const std::string& obj_T2 = "__") const {
        auto itrType = params.find(type_Key);
        if (itrType == params.end())
            THROW_IE_EXCEPTION << "Parameter of type " << type_Key << " not found";

        std::string param_val = itrType->second.as<std::string>();
        if (obj_T1 != param_val && obj_T2 != param_val)
            THROW_IE_EXCEPTION << "Unexpected object type " << param_val;

        auto itrHandle = params.find(handle_Key);
        if (itrHandle == params.end()) {
            THROW_IE_EXCEPTION << "No parameter " << handle_Key << " found";
        }

        Tmp handle = itrHandle->second;
        return static_cast<Result>(handle);
    }

    /**
    * @brief Same as _ObjFromParams(), but should be used if check
    * for object type is not required
    */
    template <typename Result>
    Result _ObjFromParamSimple(const ParamMap& params, const std::string& handle_Key) const {
        auto itrHandle = params.find(handle_Key);
        if (itrHandle == params.end()) {
            THROW_IE_EXCEPTION << "No parameter " << handle_Key << " found";
        }

        Result handle = itrHandle->second;
        return handle;
    }

    /**
    * @brief Template function that extracts string value
    * from map entry under specified key
    */
    std::string _StrFromParams(const ParamMap& params,
        std::string Key) const {
        auto itrType = params.find(Key);
        if (itrType == params.end())
            THROW_IE_EXCEPTION << "Parameter key " << Key << " not found";
        return itrType->second.as<std::string>();
    }
};

}  // namespace details

}  // namespace gpu

}  // namespace InferenceEngine