Skip to content

InscoperAPI/API/Base/Recipe/Recipe.h

Namespaces

Name
Inscoper
Inscoper namespace.

Classes

Name
class Inscoper::Recipe
Recipe class represents the protocol to create a sequence of operations.

Source code

#ifndef RECIPE_H
#define RECIPE_H

#include <Base/Recipe/RecipeElement.h>

#include <memory>

namespace Inscoper {

class INSCOPER_EXPORT Recipe {
public:
  Recipe();

  explicit Recipe(const std::string &name);

  ~Recipe();

  void fromXML(Inscoper::XMLNode &xml) INSCOPER_EXCEPTION;

  void toXML(Inscoper::XMLNode &xmlParent) INSCOPER_EXCEPTION;

  const std::string &getName() const;

  void setName(const std::string &name);

  const std::vector<Inscoper::RecipeElementPtr> &getRecipeElements() const;

  void setRecipeElementList(const std::vector<Inscoper::RecipeElementPtr> &recipeElements);

  void addRecipeElement(const Inscoper::RecipeElementPtr &recipeElement);

private:
  std::string _name;
  std::vector<Inscoper::RecipeElementPtr> _recipeElementList;
};

typedef std::shared_ptr<Recipe> RecipePtr;

} // namespace Inscoper

#endif // RECIPE_H

Updated on 2026-09-03 at 12:14:17 +0200