flow chart ...from Vi hierarchy??

[Leeser]

I know I've gone about this the wrong way...probably item #1 in the top ten things not to do when programming but...  (I'm not a software engineer, have you guessed?)

I have a fairly complex state machine vi developed and deployed and I don't have a flow chart for it. As I have been solely working on it I know what everything does and how it works, but I need to have an overview for the non-geeks out there, who will be using the standalone version.

Is there a way of generating a flow chart from the VI-hierarchy?

or what is the best way about developing the flow chart (not from the very beginning..)

Regards,

Leeser

[Ben · Accepted solution]

There is nothing automatic.

Provided it is not based on a QSM construct (this design pattern can allow transitions that are impossible to fully document...) it can be done by hand using your favorite flow diagram software (don't wince but I have been using paint and PP for this for so long that I know all of the short-cuts and can do it fast).

i have recieved code developed by other groups and drwaing up the state diagram was the first step in estimating what would be required to start supporting it.

This thread is from some years ago on a similar topic and may be of use.

Am I safe in assuming that you have learned your leason to "Design first, document second", or do you want a lecture?

Ben

[Leeser]

Oh boy have I learned...

code...revise..code...ooops...recode...what is svn?...but it works...now it doesn't...scrap..start again..

So I just have to get out my pencil and paper and somehow enlighten people as to my program flow genius...

Cheers

Leeser

[smercurio_fc]

---

@Leeser wrote:

Oh boy have I learned...

code...revise..code...ooops...recode...what is svn?...but it works...now it doesn't...scrap..start again..

---

Source code control software: http://subversion.apache.org/

You can do a search in the forum for "source code control software" and you'll find several discussions.

[johnsold]

Leeser,

If your code truly is a state machine, it should be fairly easy to generate a state diagram.  A state diagram with documentation on the transitions should completely describe what your code does to non-programmers.  It is not the same as a flow chart, but meets the same need.

Even if it is only partially a state machine, which often happens in incremental, unplanned programming, attempting to describe it by a state diagrma may be a reasonable way to start.

You may even find a few bugs or unannounced "features" which you can address beofre they become major issues.

Lynn

[Leeser]

Hi,

Well it is a State Machine based on the JKILabs State Machine Template so yeah it truly is a state machine, with all the various state transitions easily readible/documentable...so I suppose that is something.

I think it is worth saying that Ben's link to an old thread and his attached documentation therein are well worth reading, I had posted my response but couldn't edit it to include that comment.

Cheers,

Lee