wfn_place.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2026, QORE Lab, Imperial College London
 * All rights reserved.
 */
#ifndef LINE_API_WFN_WFN_PLACE_H
#define LINE_API_WFN_WFN_PLACE_H
 
/**
 * @file
 * @ingroup api_wfn
 * A place of a WorkflowNet.
 *
 * The initial marking is informational: every analysis of the net starts from
 * k tokens in the source place, as WF-net soundness does.
 *
 * MATLAB twin: matlab/src/api/wfn/WFNPlace.m
 */
 
#include <cstddef>
#include <string>
 
#include "line/util/error.h"
 
namespace line {
namespace wfn {
 
class WorkflowNet;
 
class WFNPlace {
public:
    const std::string& name() const { return name_; }
    /** 0-based position in `WorkflowNet::places()`. */
    std::size_t index() const { return index_; }
    double initial_marking() const { return initial_marking_; }
 
    /** `setInitialMarking(m)`. */
    void set_initial_marking(double marking) {
        if (marking < 0)
            throw InputError(ErrorKind("Argument"), "Initial marking cannot be negative.");
        initial_marking_ = marking;
    }
 
private:
    friend class WorkflowNet;
    WFNPlace(const std::string& name, std::size_t index, double initial_marking)
        : name_(name), index_(index), initial_marking_(initial_marking) {}
 
    std::string name_;
    std::size_t index_;
    double initial_marking_;
};
 
}  // namespace wfn
}  // namespace line
 
#endif  // LINE_API_WFN_WFN_PLACE_H