Skip to content

LSTS/DuneInspector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DuneInspector

DuneInspector allows generating UML diagrams from DUNE source code as well as IMC messages. It can be used to learn more about DUNE and better understand interactions between Tasks running in a DUNE system.

Compiling

  • To compile you need Oracle's Java Development Kit (JDK) 8 and Apache ANT.
  • In the folder of the project, just run ant inspect and the inspect binary will be produced.
  • Alternatively, you can run a pre-compiled version.

Running

  • Provided you Java 8 and GraphViz installed, you can run DuneInspector by executing the inspect binary simply by running: ./inspect which will give you a list of accepted arguments.

Examples

  • Obtain the UML (message fields) for a given IMC message: ./inspect -msg TrexToken:

Message UML

  • Obtain the class diagram of a given DUNE task: ./inspect -task Transports.GSM:

Task class diagram

  • Obtain the communications diagram of a given DUNE task: ./inspect -comms Transports.GSM

Task comms diagram

  • Obtain the communications diagram of a given Message: ./inspect -comms Salinity

Task comms diagram