computeResource.hpp

Go to the documentation of this file.

/*
 *   Copyright 2025 Huawei Technologies Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <string>
#include <nlohmann_json/json.hpp>
#include <hicr/core/definitions.hpp>
 
namespace HiCR
{
 
class ComputeResource
{
  public:
 
  [[nodiscard]] virtual std::string getType() const = 0;
 
  virtual ~ComputeResource() = default;
 
  [[nodiscard]] __INLINE__ nlohmann::json serialize() const
  {
    // Storage for newly created serialized output
    nlohmann::json output;
 
    // Getting information from the derived class
    serializeImpl(output);
 
    // Getting compute resource type
    output["Type"] = getType();
 
    // Returning serialized information
    return output;
  }
 
  __INLINE__ void deserialize(const nlohmann::json &input)
  {
    // Then call the backend-specific deserialization function
    deserializeImpl(input);
  };
 
  protected:
 
  ComputeResource() = default;
 
  virtual void serializeImpl(nlohmann::json &output) const = 0;
 
  virtual void deserializeImpl(const nlohmann::json &input) = 0;
};
 
} // namespace HiCR