Struct BusinessProcessModelAndNotation 

pub struct BusinessProcessModelAndNotation {
    pub activity_key: ActivityKey,
    pub collaboration_index: Option<(usize, ())>,
    pub collaboration_id: Option<String>,
    pub definitions_index: (usize, ()),
    pub definitions_id: String,
    pub elements: Vec<BPMNElement>,
    pub message_flows: Vec<BPMNMessageFlow>,
    /* private fields */
}

A struct with a Business Process Model and Notation (BPMN) model.

Example:

use std::io::prelude::*;
use std::io::BufReader;
use std::fs::File;
use ebi_bpmn::BusinessProcessModelAndNotation;

fn main() -> anyhow::Result<()> {
 let f = File::open("testfiles/model.bpmn")?;
 let mut reader = BufReader::new(f);

 let bpmn = BusinessProcessModelAndNotation::import_from_reader(&mut reader, true)?;

 let mut marking = bpmn.get_initial_marking()?.unwrap();
assert_eq!(bpmn.get_enabled_transitions(&marking)?, vec![0]);
 bpmn.execute_transition(&mut marking, 0)?;

Ok(())
}

To create a BPMN model programmatically, please consider using a BPMNCreator.

Fields

activity_key: ActivityKey

collaboration_index: Option<(usize, ())>

collaboration_id: Option<String>

definitions_index: (usize, ())

definitions_id: String

elements: Vec<BPMNElement>

message_flows: Vec<BPMNMessageFlow>

Implementations

impl BusinessProcessModelAndNotation

pub fn number_of_elements(&self) -> usize

Returns the number of elements in the BPMN model (recurses).

pub fn number_of_message_flows(&self) -> usize

Returns the number of message flows in the BPMN model (does not recurse).

pub fn elements(&self) -> Vec<&BPMNElement>

Returns all elements in the model (recurses).

pub fn parent_of(&self, global_index: (usize, ())) -> Option<&dyn Processable>

Returns the parent of the element or flow with the given index (recursively).

pub fn sequence_flows(&self) -> Vec<&BPMNSequenceFlow>

Returns all sequence flows (recurses).

pub fn global_index_2_element(&self, index: (usize, ())) -> Option<&BPMNElement>

Find an element with the given index (recurses).

pub fn global_index_2_element_mut( &mut self, index: (usize, ()), ) -> Option<&mut BPMNElement>

Find an element with the given index and returns a mutable reference to it (recurses).

pub fn message_flow_index_2_source( &self, message_flow_index: usize, ) -> Result<&BPMNElement, Error>

Returns the element that is the source of the given message flow.

pub fn message_flow_index_2_target( &self, message_flow_index: usize, ) -> Result<&BPMNElement, Error>

Returns the element that is the target of the given message flow.

pub fn global_index_2_message_flow( &self, message_flow_global_index: (usize, ()), ) -> Option<&BPMNMessageFlow>

Returns the sequence flow with the given global index.

pub fn global_index_2_sequence_flow_and_parent( &self, sequence_flow_global_index: (usize, ()), ) -> Option<(&BPMNSequenceFlow, &dyn Processable)>

Returns the sequence flow with the given global index.

pub fn global_index_2_sequence_flow_mut( &mut self, sequence_flow_global_index: (usize, ()), ) -> Option<&mut BPMNSequenceFlow>

Returns the sequence flow with this index, if it exists (recurses).

impl BusinessProcessModelAndNotation

pub fn export_to_writer(&self, f: &mut dyn Write) -> Result<(), Error>

Exports the model to a writer.

impl BusinessProcessModelAndNotation

pub fn import_from_reader( reader: &mut dyn BufRead, disallow_sequence_flow_weights: bool, ) -> Result<BusinessProcessModelAndNotation, Error>

where BusinessProcessModelAndNotation: Sized,

Attempts to import a BPMN model. If disallow_sequence_flow_weights is set to true, parsing will fail if any sequence flow has a weight. Will only succeed if the model is structurally correct.

impl BusinessProcessModelAndNotation

pub fn get_initial_marking(&self) -> Result<Option<BPMNMarking>, Error>

Returns the initial marking, as specified by the BPMN 2.0.2 standard on page 238. Additionally, if the model is empty, it does not support any trace, and this function returns Ok(None). If the model is structurally correct, this method will always return Ok(..). If not, will return Err() but will not panic.

pub fn execute_transition( &self, marking: &mut BPMNMarking, transition_index: usize, ) -> Result<(), Error>

Updates the marking by executing the transition. By contract, will return Ok() if the model is structurally correct and the transition was enabled. May panic or return Err() otherwise.

pub fn is_final_marking(&self, marking: &BPMNMarking) -> Result<bool, Error>

Returns whether the marking is a final marking. That is, whether no transitions are enabled in it. If the model is structurally correct, this function will always return Ok(). If the model is not structurally correct, this function may return Err() but will not panic.

pub fn is_transition_silent( &self, transition_index: usize, marking: &BPMNMarking, ) -> bool

Returns true if the transition exists and is unlabelled, otherwise, returns false. Does not panic.

pub fn get_transition_activity( &self, transition_index: usize, marking: &BPMNMarking, ) -> Option<Activity>

If the transition exists and is labelled, returns the label. Otherwise, returns None.

pub fn get_enabled_transitions( &self, marking: &BPMNMarking, ) -> Result<Vec<usize>, Error>

Returns the transitions that are enabled in the given marking. By contract, will return Ok() if the model is structurally correct. Otherwise, it will return Err() but will not panic.

pub fn number_of_transitions(&self, marking: &BPMNMarking) -> usize

Returns the number of transitions of the current marking. Note that not all of these transitions are necessarily enabled.

pub fn transition_debug( &self, transition_index: usize, marking: &BPMNMarking, ) -> Option<String>

Print a list of transitions at the current marking.

pub fn transition_2_consumed_tokens( &self, transition_index: usize, marking: &BPMNMarking, ) -> Result<Vec<Token>, Error>

Returns the tokens that are consumed when this transition is fired, or None if the transition does not exist.

pub fn transition_2_produced_tokens( &self, transition_index: usize, marking: &BPMNMarking, ) -> Result<Vec<Token>, Error>

Returns the tokens that are produced when this transition is fired, or None if the transition does not exist.

impl BusinessProcessModelAndNotation

pub fn is_structurally_correct(&self) -> Result<(), Error>

Verify whether the model is structurally correct using several, though not exhaustive, checks. If the BPMN model is imported by import_from_reader or created using a BPMNCreator, there is no need to call this method.

Trait Implementations

impl BPMNObject for BusinessProcessModelAndNotation

fn global_index(&self) -> (usize, ())

return the global index

fn local_index(&self) -> usize

return the index within its parent

fn id(&self) -> &str

return the id

fn activity(&self) -> Option<Activity>

Returns the activity, if this element has one

fn is_unconstrained_start_event( &self, _bpmn: &BusinessProcessModelAndNotation, ) -> Result<bool, Error>

return whether this is a start event that could initiate a process instance

fn is_end_event(&self) -> bool

return whether this is an end event

fn incoming_sequence_flows(&self) -> &[usize]

the flow indices of the incoming sequence flows of this object

fn outgoing_sequence_flows(&self) -> &[usize]

the flow indices of the outgoing sequence flows of this object

fn incoming_message_flows(&self) -> &[usize]

the flow indices of the incoming message flows of this object

fn outgoing_message_flows(&self) -> &[usize]

the flow indices of the outgoing message flows of this object

fn can_start_process_instance( &self, _bpmn: &BusinessProcessModelAndNotation, ) -> Result<bool, Error>

return whether this object could start a process instance, regardless of marking

fn outgoing_message_flows_always_have_tokens(&self) -> bool

return whether the outgoing message flows of this object are always enabled

fn outgoing_messages_cannot_be_removed(&self) -> bool

return whether any outgoing message flow of this object cannot be removed when it is there If true, do not produce more than 1 message and do not remove messages from message flows outgoing of this object.

fn incoming_messages_are_ignored(&self) -> bool

Return whether any incoming messages are ignored. If true, do not produce messages on message arcs coming into this object.

fn can_have_incoming_sequence_flows(&self) -> bool

return whether this object can have incoming sequence flows

fn can_have_outgoing_sequence_flows(&self) -> bool

return whether this object can have incoming sequence flows

impl Clone for BusinessProcessModelAndNotation

fn clone(&self) -> BusinessProcessModelAndNotation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BusinessProcessModelAndNotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for BusinessProcessModelAndNotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Exportable for BusinessProcessModelAndNotation

fn export_from_object(object: EbiObject, f: &mut dyn Write) -> Result<()>

Input: any EbiObject. Output: the object will have been converted if necessary, and written to f. May fail for all kinds of reasons.

fn export(&self, f: &mut dyn Write) -> Result<()>

impl From<ProcessTree> for BusinessProcessModelAndNotation

fn from(value: ProcessTree) -> Self

Converts to this type from the input type.

impl From<ProcessTreeMarkupLanguage> for BusinessProcessModelAndNotation

fn from(value: ProcessTreeMarkupLanguage) -> Self

Converts to this type from the input type.

impl From<StochasticBusinessProcessModelAndNotation> for BusinessProcessModelAndNotation

fn from( value: StochasticBusinessProcessModelAndNotation, ) -> BusinessProcessModelAndNotation

Converts to this type from the input type.

impl From<StochasticProcessTree> for BusinessProcessModelAndNotation

fn from(value: StochasticProcessTree) -> Self

Converts to this type from the input type.

impl FromStr for BusinessProcessModelAndNotation

type Err = Error

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<BusinessProcessModelAndNotation, <BusinessProcessModelAndNotation as FromStr>::Err>

Parses a string s to return a value of this type.

impl Graphable for BusinessProcessModelAndNotation

fn to_dot(&self) -> Result<VisualGraph>

impl HasActivityKey for BusinessProcessModelAndNotation

fn activity_key(&self) -> &ActivityKey

fn activity_key_mut(&mut self) -> &mut ActivityKey

impl Importable for BusinessProcessModelAndNotation

const IMPORTER_PARAMETERS: &[ImporterParameter]

Defines the parameters that the importer expects.

const FILE_FORMAT_SPECIFICATION_LATEX: &str = "A Business Process Model and Notation (BPMN) model follows the OMG 2.0.2 standard~\\cite{omg2011bpmn}. Currently, a sub-set of elements is supported."

A latex piece that describes the file format.

fn import_as_object( reader: &mut dyn BufRead, parameter_values: &ImporterParameterValues, ) -> Result<EbiObject>

fn import( reader: &mut dyn BufRead, _parameter_values: &ImporterParameterValues, ) -> Result<Self>

where Self: Sized,

Attempts to import from the reader. The parameter_values must match the order given in IMPORTER_PARAMETERS.

fn default_importer_parameter_values() -> ImporterParameterValues

impl Infoable for BusinessProcessModelAndNotation

fn info(&self, f: &mut impl Write) -> Result<()>

impl Processable for BusinessProcessModelAndNotation

fn elements_non_recursive(&self) -> &Vec<BPMNElement>

Returns the elements of this process, but does not recurse.

fn sequence_flows_non_recursive(&self) -> &Vec<BPMNSequenceFlow>

return the sequence flows of this process, but do not recurse.

fn to_sub_marking( &self, _initiation_mode: &InitiationMode<'_>, ) -> Result<BPMNSubMarking, Error>

return a initial marking

fn is_sub_process(&self) -> bool

return whether this is a sub-process, i.e. not a pool or a root of the model.

fn sequence_flow_index_2_source( &self, sequence_flow_index: usize, ) -> Result<&BPMNElement, Error>

return the element that is the target of the given sequence flow

fn sequence_flow_index_2_target( &self, sequence_flow_index: usize, ) -> Result<&BPMNElement, Error>

return the element that is the target of the given sequence flow

impl TranslateActivityKey for BusinessProcessModelAndNotation

fn translate_using_activity_key(&mut self, to_activity_key: &mut ActivityKey)

Change the activity key of this object, by translating all mentions of activities to the new activity key (which will be updated with activity labels it did not have yet.). This is a potentially expensive operation. If only a part of the activities will be used, then consider using an ActivityKeyTranslator directly. The activity key of this object will be updated too, so the activity keys will be equivalent afterwards.

impl TryFrom<BusinessProcessModelAndNotation> for StochasticBusinessProcessModelAndNotation

fn try_from( value: BusinessProcessModelAndNotation, ) -> Result<StochasticBusinessProcessModelAndNotation, <StochasticBusinessProcessModelAndNotation as TryFrom<BusinessProcessModelAndNotation>>::Error>

Attempt to transform a BPMN model into an SBPMN model. This is possible if the appropriate sequence flows are annotated with weights.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<DeterministicFiniteAutomaton> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: DeterministicFiniteAutomaton) -> Result<Self>

Performs the conversion.

impl TryFrom<DirectlyFollowsGraph> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: DirectlyFollowsGraph) -> Result<Self>

Performs the conversion.

impl TryFrom<DirectlyFollowsModel> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: DirectlyFollowsModel) -> Result<Self>

Performs the conversion.

impl TryFrom<LabelledPetriNet> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: LabelledPetriNet) -> Result<Self>

Performs the conversion.

impl TryFrom<PetriNetMarkupLanguage> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PetriNetMarkupLanguage) -> Result<Self>

Performs the conversion.

impl TryFrom<StochasticDeterministicFiniteAutomaton> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: StochasticDeterministicFiniteAutomaton) -> Result<Self>

Performs the conversion.

impl TryFrom<StochasticDirectlyFollowsModel> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: StochasticDirectlyFollowsModel) -> Result<Self>

Performs the conversion.

impl TryFrom<StochasticLabelledPetriNet> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: StochasticLabelledPetriNet) -> Result<Self>

Performs the conversion.

impl TryFrom<StochasticNondeterministicFiniteAutomaton> for BusinessProcessModelAndNotation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: StochasticNondeterministicFiniteAutomaton) -> Result<Self>

Performs the conversion.