-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
296 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| %% -*- erlang -*- | ||
| %% | ||
| %% A generic Petri net OTP behavior. | ||
| %% | ||
| %% Copyright 2016-2017 Jorgen Brandt. | ||
| %% | ||
| %% 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. | ||
| %% | ||
| %% ------------------------------------------------------------------- | ||
| %% @author Jorgen Brandt <joergen.brandt@onlinehome.de> | ||
| %% @version 0.1.1 | ||
| %% @copyright 2016-2017 Jorgen Brandt. | ||
| %% @doc Callback function definitions for Petri net structure definition. | ||
| %% | ||
| %% There are six callbacks that define the Petri net structure and its initial | ||
| %% marking: | ||
| %% | ||
| %% <ul> | ||
| %% <li>`place_lst/0' returns the names of the places in the net</li> | ||
| %% <li>`trsn_lst/0' returns the names of the transitions in the net</li> | ||
| %% <li>`init_marking/1' returns the initial marking for a given place</li> | ||
| %% <li>`preset/1' returns the preset places of a given transition</li> | ||
| %% <li>`is_enabled/2' determines whether a given transition is enabled in a | ||
| %% given mode</li> | ||
| %% <li>`fire/2' returns which tokens are produced on what places if a given | ||
| %% transition is fired in a given mode that enables this transition</li> | ||
| %% </ul> | ||
| %% | ||
| %% We have a look at each of them in turn. | ||
| %% | ||
| %% <h4>place_lst/0</h4> | ||
| %% | ||
| %% The `place_lst/0' function lets us define the names of all places in the net. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% place_lst() -> | ||
| %% [coin_slot, cash_box, signal, storage, compartment]. | ||
| %% ''' | ||
| %% Here, we define the net to have the five places in the cookie vending | ||
| %% machine. | ||
| %% | ||
| %% <h4>trsn_lst/0</h4> | ||
| %% | ||
| %% The `trsn_lst/0' function lets us define the names of all transitions in the | ||
| %% net. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% trsn_lst() -> | ||
| %% [a, b]. | ||
| %% ''' | ||
| %% Here, we define the net to have the two places `a' and `b' in the cookie | ||
| %% vending machine. | ||
| %% | ||
| %% <h4>preset/1</h4> | ||
| %% | ||
| %% The `preset/1' lets us define the preset places of a given transition. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% preset( a ) -> [coin_slot]; | ||
| %% preset( b ) -> [signal, storage]. | ||
| %% ''' | ||
| %% Here, we define the preset of the transition `a' to be just the place | ||
| %% `coin_slot' while the transition `b' has the places `signal' and `storage' | ||
| %% in its preset. | ||
| %% | ||
| %% <h4>init_marking/1</h4> | ||
| %% | ||
| %% The `init_marking/1' function lets us define the initial marking for a given | ||
| %% place in the form of a token list. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% init_marking( storage ) -> [cookie_box, cookie_box, cookie_box]; | ||
| %% init_marking( _ ) -> []. | ||
| %% ''' | ||
| %% Here, we initialize the storage place with three `cookie_box` tokens. All | ||
| %% other places are left empty. | ||
| %% | ||
| %% <h4>is_enabled/2</h4> | ||
| %% | ||
| %% The `is_enabled/2' function is a predicate determining whether a given | ||
| %% transition is enabled in a given mode. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% is_enabled( a, #{ coin_slot := [coin] } ) -> true; | ||
| %% is_enabled( b, #{ signal := [sig], storage := [cookie_box] } ) -> true; | ||
| %% is_enabled( _, _ ) -> false. | ||
| %% ''' | ||
| %% Here, we state that the transition `a' is enabled if it can consume a single | ||
| %% `coin' from the `coin_slot' place. Similarly, the transition `b' is enabled | ||
| %% if it can consume a `sig' token from the `signal' place and a `cookie_box' | ||
| %% token from the `storage` place. No other configuration can enable a | ||
| %% transition. E.g., managing to get a `button' token on the `coin_slot' place | ||
| %% will not enable any transition. | ||
| %% | ||
| %% <h4>fire/2</h4> | ||
| %% | ||
| %% The `fire/2' function defines what tokens are produced when a given | ||
| %% transition fires in a given mode. As arguments it takes the name of the | ||
| %% transition, and a firing mode in the form of a hash map mapping place names | ||
| %% to token lists. The `fire/2' function is called only on modes for which | ||
| %% `is_enabled/2' returns `true'. The `fire/2' function is expected to return | ||
| %% either a `{produce, ProduceMap}' tuple or the term `abort'. If `abort' is | ||
| %% returned, the firing is aborted. Nothing is produced or consumed. | ||
| %% | ||
| %% Example: | ||
| %% ``` | ||
| %% fire( a, _ ) -> {produce, #{ cash_box => [coin], signal => [sig] }}; | ||
| %% fire( b, _ ) -> {produce, #{ compartment => [cookie_box] }}. | ||
| %% ''' | ||
| %% Here, the firing of the transition `a' produces a `coin' token on the | ||
| %% `cash_box' place and a `sig' token on the `signal' place. Similarly, the | ||
| %% firing of the transition `b' produces a `cookie_box' token on the | ||
| %% `compartment' place. We do not need to state the tokens to be consumed | ||
| %% because the firing mode already uniquely identifies the tokens to be | ||
| %% consumed. | ||
| %% | ||
| %% @end | ||
| %% ------------------------------------------------------------------- | ||
|
|
||
|
|
||
| -module( gen_pnet_struct ). | ||
|
|
||
| -callback place_lst() -> [atom()]. | ||
|
|
||
| -callback trsn_lst() -> [atom()]. | ||
|
|
||
| -callback init_marking( atom() ) -> [_]. | ||
|
|
||
| -callback preset( Place :: atom() ) -> [atom()]. | ||
|
|
||
| -callback is_enabled( Trsn :: atom(), Mode :: #{ atom() => [_]} ) -> boolean(). | ||
|
|
||
| -callback fire( Trsn :: atom(), Mode :: #{ atom() => [_] } ) -> | ||
| abort | {produce, #{ atom() => [_] }}. |