BasicPI

I created a simple Hello World diagram (below), saved it, Imported it to itself and made a copy/paste – so below I have 2 x Module 1, 2 x Diagram 1 and 3 x Hello World. This is just an integrity check on the drawing engine as the engine uses an unique reference and not the names. So from a free drawing perspective this is fine – you can do this in a text editor while a proper editor will tag Module 1 and Hello World as duplicated – meaning you can draw what you want, but the compiler will stop you from generating code since you from a programming perspective have errors.

In this firsr version we focus on design and the capability to make drawings and illustrations (modelling) – a typical usage is that we discuss two or three alternative implementation or just want some drawing freedom as part of the design process – meaning the tool should not limit us. BSA is a very fast drawing tool on these specialized diagrams and we can easely combine drawings with notes and free text where we do not want to be stopped by programming language rules. So – in short we need to allow this because design and documentation is an important bonus we get free from BSA.

The question is how do we precent this in Dictionary and digrams? What we have above is “Hello World”, but assume you do this by accident with hundreds of objects – we need a way for the user to be able to do this deliberately while it also must be obvious that this is an illegal diagram. I plan to run the compiler as a background task so the integrity check will always pop up a almost instantly.

We also have a similar need as we code – we need to make new versions of code and be able to comment out code as we test etc – and using a text editor this is simple, so we should be able to de exactly the same here. From a coding perspective this is straight forward as we could mark illegal situations clearly and force the user to correct situations or comment the out. But, we need something that work for free design as well.

I will experiment with flags in the dictionary and the adding a “Comment” or “Design” tag in the left-top corner to comment out entire diagrams – we seriously need that option and a system to maintain multiple versions of diagrams anyway. It is also a question if we should add a legend option similar to those in other CAD tools. These can easily be added in fixed positions on top of the digrams and be included/removed from printing/clipboard at the users option. Myself I would preffer to see a tag if I look at an older version of a diagram.

I have started to add four functions “Import, Cut, Copy and Paste”, The example below import a copy of the existing module into the repository. The main challenge to maintain integrity is straight forward as integrity is based on a unique, internal reference that needs to be updated. Names are only a precentation on this level. The more interesting issue is precentation of objects like Module 1, Diagram 1 and Class88 that now are duplicated as we in this example end up wih two of each. I only need to change the 2nd Module name as the full name of Class88 is “Module1.Diagram 1.Class88” etc, but I hesitate to start using the full, formal names everythere.

Cut, Copy and Paste is simlar to Import with the exception that you can operate within a module and as such you need to change names of ojects. If you copy a object between modules we need to make a physical copy, but if the copy a class inside a module we could make a new precentation of the original or we could create a new original. All of this must be handled in the UI.

Import is a must for several people to work on the same project and I probably need a merge option – that said I want to experiement with GIT first because two or more developers should be able to merge projects using GIT. The challenge is the references because as two users work in parallell they might be using the same references for different things – in which case GIT Merge will screw things up :(. I am also fully aware that a GIT Merge tend to screw up if two developers have worked on the same file, so it might be safer to handle Merge in BSA. I need to think about this one.

It still is a bit of work left before I am happy with the integrity and functionality of BSA:

• I need some improvements on clipboard copy, basically to copy selections rather than full diagrams.
• Import needs to work.
• Copy/Paste must work.
• Multiple Modules must work.
• And I will need to optimize Dictionary precentation.
• And test and fix bugs.

I also need to design an undo/redo mechanism, but I can release a beta without this. The reason I push on Import, cut, copy paste now is because they affect the core concept of how fast you can work – as in productivity. BSA is pretty fast to draw diagrams with as is, but as my test project grows I miss options to copy/paste to capitilize on things I already have done. One discussion coming up is my text editor in the Property Editor – it works, but it ends op on the right side as very small text. I also enter a lot of text that I need to precent in tables and get into documents. Documentation is important because it is something we can do a lot of automation on – the hard reality for many of us is that we make less doc than we should do because of lack of time – and doc in my case is precented to management that is stakeholders in work you do.

I was considering HMI as my next release, but it might be that I start pushing on Code Generators. To generate source code I will be re-using an old concept I developed back in 1995 – a specialized template language where you manually write the code and then modify content with a specialized markup language. This means the code that is generated is 100% controlled by yourself as it should be – the last functionality I then need is to be able to import tool kits and let the user create new tools. I will keep the build-in tools as a base, but users should be able to create their own libraries of code and tools.

One concept I am eager to push is to make more of BSA using BSA, but that is for a later day 🙂

SDL (Specification and Description Language) was at one point considered as a UML diagram add-on, but UML went in a different direction. I am used to SDL from Telecom and use an abstracted version (simplified) because I liked the state engine concept added to normal flow charts – so why did I bother with UML State diagrams on top of SDL? The answer is that UML State diagrams are superier on showing information flow on the higher level, while SDL is superior then dealing with executable logic on lower levels. The two methods complement each other well. In the example below I have drawn a diagram – UML State Diagram at left and SDL at right where the SDL part actually is the executable flow chart inside the UML block at left.

PLD (Plain Logic Diagram) is a Flow chart with some abstracted SDL added as well as UML State diagrams added. It is a bit of work before we can start generating code, but my previous experince with SDL is that a common user need about 5 minutes to learn reading the diagrams. We actually used these diagrams as a specification on some systems and they are great as we did not have a single dispute over functionality – the only issue at the time was that drawing these diagrams without a specialized tool is to time consuming. BSA will change that!

Changing UML State is straight forward – just use ToolMake to add a new property and change the default settings + a few lines of code to add the header change I also added. This is a compromise on my earlier Connection Point – I decided to change the default to Free and implement Free as no CP’s shown for now. I have already changed Start and Exit symbols and that is basically most of what I need right now – the next step is to change Flow lines. This means I keep existing functionality (for now), but change default behavior only.

I keep praising ToolMaker, the utility I decided to make som time back. It is a simple table driven aproach to change properties and the generated code automatically make the usable in diagrams and set up the editor for them. This is also a lesson learned because the amount of work they have saved me is increadible due to the watse number or properties.

Another tool I really start to like is the Copy function that allows me to copy diagrams into emails and documents (below) – I still have work to do on Clipboard and Print, but I am using the Copy function daily now. In the end I decided to only convert text and background colors on a hard-coded scheme (for now).

I wanted to draw some simple, high level UML State diagrams using PLD and while it worked I also used far more time than I expected. This was in many ways a big failure with regards to the objectives I have set, so I need to do some re-thinking.

In this first diagram I use Connection Points (CP) to draw lines. The issue is that links in this case only goes between CP’s and from left to right. As the CP positions are automated it becomes close to impossible to have straight, nice lines and as the diagrams grows this becomes messy and we start using more and more time on making diagrams look pretty. More important is that real diagrams is very limited if you draw only top-down or left-right + I ended up removing the automated event/method names as well. All in all I managed to draw the diagram I wanted, but I concluded that I had achieved the opposite of what I wanted – I ended up using a lot of time fiddling with lines – lesson learned!

This next diagram is the same, but here I switched to Free drawing to avoid the CP’s. In this case the diagram is cleaner, I can easily make lines straight  and notice the added lines that goes back or use other edges. A State Diagram show flow of events/info between objects and visualizing the below using CP’s that only was Top-Left or Left-Right simply did not work well,

So, how do we move forward? Some of you will recall that we started with simple lines and changed to using CP’s. The arguments was that CP’s visualized what events that was available and also visualized mandatory events etc (mandatory must be implemented) – so yes going back to pure lines will add some work as we need another method to specify events and methods.

The name labes are the easy ones – I currently let CP’s control displaying of labels (event names or method names), but I will move that to the lines itself anyway. It is also possible that I can allow user to move CP’s themselves or simple not show the CP’s once they are connected. Moving a CP is a bit difficult as current mouse click is connect, but lets see. On the other hard I also want to be able to connect to the same method on several edges without having CP positions forcing my hand. What I will miss is the functionality where you just use your mouse, click on a CP and connect to another CP as having to select the Flow tool is extra work, but now I am just being pouty 🙁

As for getting things right – we have the compiler that can pick up if flow lines are properly terminated or not, but the nice think is that we can chose to not care about thos details as we design as it is an implementation issue.

Just for the record – PLD cover UML State Diagrams, SDL (Specification and Description Language) as well as basic flow charts. PLD is a merge of those modelling techniques. Your diagrams can be what you want them to be + design is an important task of SW engineering, so having nice, precentable diagrams are a must.

Another issue I need to dig into is flow of events vs flow of data. I had a need to differ the two for illustrative purposes. And I also need an option to use a single line for multiple events on high level diagrams – this can be a special, thicker line where the user can drill down to see details. All in all – this had to be expected – adjustments as we start using the tool.

The UML State Diagram below illustrates an Actuator that regulate on Position, Speed and Torque, but is input data here Events, Data or both? Also the diagram show event name three times. In this case the gray names should be hidden as the Start Terminal carry the event name. I am not sure I need to differ between Data and Event as Event carry parameters and can carry new info in parameters or be a trigger to read a table.

Just for the record below is the clipboard version of the diagram that can be Pasted into any doc.

BSA uses the terminology “Module” for an independent sub-project that can be anything you want from a Windows executable, to library or Embedded Image. The content is up to the developer. I just added a menu to create new modules and I am not 100% sure about the result in the visual dictionary. I lack a method to visualize what module I work on for one, but using the same folder visualization for everything makes it confusing what is what. I will need to work a bit on this.

I probably should hide empty folders as well + add separate icons to folders. Content do have separate Icons. As we start to store a repository in separate files we might also need a file/folder directory – not sure.

It is also a question if I should show content as Module->Diagram->Content and how I should apply folders as we might expect large modules.

In my first clipboard example I borrowed some code that copied a UserControl “as is” to the clipboard. If you study that code you will notice that it performs two steps:

• Create a bitmap from a UI Control
• Copy Bitmap to Clipboard

As the Canvas I use is dark theme background and the UserControl have grid lines and controls that is not part of the diagram that comes out a bit grim, so what I do next is to create a Canvas, copy symbols I need to the Canvas and then create a bitmap from this Canvas. In my case that is basically a copy of the code I used for Print/Preview.

• Create new Canvas
• Copy graphics you want to new Canvas
• call canvas.Arrange()
• Create a bitmap
• Copy bitmap to clipboard and voila…

This gives me a solution to copy a diagram, change background/colors and copy that to the clipboard. The result can be seen below.

I still need to convert some colors correctly – or more correctly set up a editable conversiontable between light and dark theme since I use dark theme on screens and print and clipboard is light color themes.

The Property Editor is great and almost work as an inline editor, but as I work with visual content line names and text I keep looking at the diagram as I type, not at the Property Editor so adding a full inline editor is on my list of ToDo. Inline editing is straight forward as we only activate an edit box in the diagram, but it is a bit of work as this needs to be specialized per visual symbol. The graphics engine have a design layer to support inline editing – the select markes you see (yellow dots) use that layer. This allows me to add other inline editor tools as well later.