ExtensionElements.h

Go to the documentation of this file.

#ifndef BPMNOS_Model_ExtensionElements_H
#define BPMNOS_Model_ExtensionElements_H
 
#include <memory>
#include <vector>
#include <string>
#include <bpmn++.h>
#include "Attribute.h"
#include "AttributeRegistry.h"
#include "Restriction.h"
#include "Operator.h"
#include "Choice.h"
#include "MessageDefinition.h"
#include "Guidance.h"
#include "model/bpmnos/src/xml/bpmnos/tAttribute.h"
 
namespace BPMNOS::Model {
 
 
/**
 * @brief Class holding extension elements representing execution data for nodes 
 **/
class ExtensionElements : public BPMN::ExtensionElements {
public:
  ExtensionElements(XML::bpmn::tBaseElement* baseElement, const AttributeRegistry attributeRegistry_, BPMN::Scope* parent = nullptr, std::vector<std::reference_wrapper<XML::bpmnos::tAttribute>> = {});
  AttributeRegistry attributeRegistry; ///< Registry allowing to look up all status and data attributes by their names.
  const BPMN::Scope* parent;
 
//  enum Index { Instance, Timestamp }; ///< Indices for instance and timestamp attribute.
  struct Index {
    static constexpr size_t Instance = 0; 
    static constexpr size_t Timestamp = 0; 
  };
  
  std::vector< std::unique_ptr<Attribute> > attributes; ///< Vector containing new status attributes declared for the node.
  std::vector< std::unique_ptr<Restriction> > restrictions; ///< Vector containing new restrictions provided for the node.
  std::vector< std::unique_ptr<Operator> > operators;
  std::vector< std::unique_ptr<Choice> > choices;
 
  std::set<const Attribute*> entryDependencies; ///< Set containing all input attributes influencing the entry feasibility.
  std::set<const Attribute*> exitDependencies; ///< Set containing all input attributes influencing the exit feasibility.
  std::set<const Attribute*> operatorDependencies; ///< Set containing all input attributes influencing the result of applying all operators.
  std::set<const Attribute*> choiceDependencies; ///< Set containing all input attributes influencing the result of making choices.
 
  std::vector< std::unique_ptr<Attribute> > data;  ///< Vector containing data attributes declared for data objects within the node's scope.
 
  struct { std::vector<const Attribute*> attributes; bool global = false; } dataUpdate; ///< Struct containing data attributes that are modified through operators and a flag indicating whether a global value is changed.
 
  std::vector< std::unique_ptr<MessageDefinition> > messageDefinitions; ///< Vector containing message definition(s) provided for the node.
  const MessageDefinition* getMessageDefinition(size_t index) const;
  const MessageDefinition* getMessageDefinition(const BPMNOS::Values& status) const;
 
  std::vector< const BPMN::FlowNode* > messageCandidates; ///< Vector containing all potential sending or receiving nodes of a message.
 
  std::vector< std::unique_ptr<Restriction> > conditions; ///< Vector containing conditions that may be provided for conditional events.
 
  std::optional< std::unique_ptr<Parameter> > loopCardinality;  ///< Number of instances to be generated.
  std::optional< std::unique_ptr<Parameter> > loopIndex; ///< Attribute holding the automatically generated loop index.
  std::optional< std::unique_ptr<Parameter> > loopCondition; ///< Boolean attribute indicating whether an exit condition holds.
  std::optional< std::unique_ptr<Parameter> > loopMaximum;  ///< Maximum number of iterations of a standard loop (requires loopIndex).
  
  bool hasSequentialPerformer; ///< Boolean indicating whether element has a performer with name "Sequential".
 
  template <typename DataType>
  bool feasibleEntry(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const;
  
  template <typename DataType>
  bool feasibleExit(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const;
  
  template <typename DataType>
  bool satisfiesInheritedRestrictions(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const;
  
  template <typename DataType>
  bool fullScopeRestrictionsSatisfied(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const;
  
  bool isInstantaneous; ///< Boolean indicating whether operators may modify timestamp.
 
  template <typename DataType>
  void computeInitialValues(BPMNOS::number currentTime, BPMNOS::Values& status, DataType& data, BPMNOS::Values& globals) const;
 
  template <typename DataType>
  void applyOperators(BPMNOS::Values& status, DataType& data, BPMNOS::Values& globals) const;
 
  template <typename DataType>
  BPMNOS::number getObjective(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const; ///< Returns the total objective of all attributes provided.
 
  template <typename DataType>
  BPMNOS::number getContributionToObjective(const BPMNOS::Values& status, const DataType& data, const BPMNOS::Values& globals) const; ///< Returns the contribution to the objective by the attributes declared for the node.
  
  std::optional< std::unique_ptr<Guidance> > messageDeliveryGuidance;
  std::optional< std::unique_ptr<Guidance> > entryGuidance;
  std::optional< std::unique_ptr<Guidance> > exitGuidance;
  std::optional< std::unique_ptr<Guidance> > choiceGuidance;
};
 
} // namespace BPMNOS::Model
 
#endif // BPMNOS_Model_ExtensionElements_H