Class GenerateCD

  • All Implemented Interfaces:
    com.vp.plugin.VPPlugin, com.vp.plugin.VPPluginCommandLineSupport

    public class GenerateCD
    extends java.lang.Object
    implements com.vp.plugin.VPPlugin, com.vp.plugin.VPPluginCommandLineSupport
    VP (Visual Paradigm) plug-in to generate simple class diagrams.

    Plug-in is executed using the VP script Plugin.sh (located in VP install scripts directory). VP documentation Running Plug-in.

    To execute this plug-in:
    Plugin.sh -project <VP_project>.vpp -pluginid GenerateCD -pluginargs "<fully.qualified.className>"

    Example:
    Plugin.sh -project /path/to/project.vpp -pluginid GenerateCD -pluginargs "gda.scan.ScanBase"

    The plug-in uses the VP Open API (Javadoc).

    TODO currently this generates too much output for normal use; a debug/verbose arg/flag should be added to control this (current output useful during dev/debug).

    TODO add more information about use of InstantReverse.sh and ExportDiagramImage.sh

    TODO add more information about why diagrams created are described as 'simple', i.e. do not contain all classes and connections as produced by VP due to limiting number of connections examined in the VP model contained in the VP project.

    • Constructor Summary

      Constructors 
      Constructor Description
      GenerateCD()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void invoke​(java.lang.String[] args)
      Method of VPPluginCommandLineSupport that is called when plug-in is executed from a script.
      void loaded​(com.vp.plugin.VPPluginInfo info)  
      void unloaded()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GenerateCD

        public GenerateCD()
    • Method Detail

      • loaded

        public void loaded​(com.vp.plugin.VPPluginInfo info)
        Specified by:
        loaded in interface com.vp.plugin.VPPlugin
      • unloaded

        public void unloaded()
        Specified by:
        unloaded in interface com.vp.plugin.VPPlugin
      • invoke

        public void invoke​(java.lang.String[] args)
        Method of VPPluginCommandLineSupport that is called when plug-in is executed from a script.
        Specified by:
        invoke in interface com.vp.plugin.VPPluginCommandLineSupport