logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Autodia::Diagram - Class to hold a collection of objects representing parts of a Dia Diagram.

Author

       Aaron Trevena, <aaron.trevena@gmail.com>

Methods

ClassMethods
       new - constructor method
           creates and returns an unpopulated diagram object.

   Objectmethods
       To  get  a  collection  of  a  objects  of  a  certain  type  you  use  the  method  of the same name. ie
       $Diagram->Classes() returns an array of 'class' objects.

       The methods available are  Classes(),  Components(),  Superclasses(),  Inheritances(),  Relations(),  and
       Dependencies(); These are all called in the template to get the collections of objects to loop through.

       To   add   an   object   to   the   diagram.   You   call  the  add_<object  type>  method,  for  example
       $Diagram->add_class($class_name), passing the name of the object in the case  of  Class,  Superclass  and
       Component but not Inheritance or Dependency which have their names generated automagically.

       Objects  are  not  removed, they can only be superseded by another object; Component can be superseded by
       Superclass which can superseded by Class. This is handled by the object itself rather than the diagram.

   AccessingandmanipulatingtheDiagram
       Elements are added to the Diagram through the add_<elementname> method (ie add_classes() ).

       Collections of elements are retrieved through the <elementname> method (ie Classes() ).

       The diagram is laid out and output to a file using the export_xml() method.

   SeeAlso
       Autodia

       Autodia::Diagram::Object

       Autodia::Diagram::Class

       Autodia::Diagram::Superclass

       Autodia::Diagram::Component

       Autodia::Diagram::Inheritance

       Autodia::Diagram::Relation

       Autodia::Diagram::Dependancy

Name

       Autodia::Diagram - Class to hold a collection of objects representing parts of a Dia Diagram.

Synopsis

       use Autodia::Diagram;

       my $Diagram = Autodia::Diagram->new;

   Description
       Diagram is an object that contains a collection of diagram elements and the logic to generate the diagram
       layout as well as to output the diagram itself in Dia's XML format using template toolkit.

See Also