.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Autodia::Diagram::Class 3pm" .TH Autodia::Diagram::Class 3pm "2022-11-02" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Autodia::Diagram::Class \- Class that holds, updates and outputs the values of a diagram element of type class. .SH "SYNOPSIS" .IX Header "SYNOPSIS" use Autodia::Diagram::Class; .PP my \f(CW$Class\fR = Autodia::Diagram::Class\->new; .SS "Description" .IX Subsection "Description" Autodia::Diagram::Class is an object that represents the Dia \s-1UML\s0 Class element within a Dia diagram. It holds, outputs and allows the addition of attributes, relationships and methods. .SH "METHODS" .IX Header "METHODS" .SS "Constructor" .IX Subsection "Constructor" my \f(CW$Class\fR = Autodia::Diagram::Class\->new($name); .PP creates and returns a simple Autodia::Diagram::Class object, containing its name and its original position (default 0,0). .SS "Accessors" .IX Subsection "Accessors" Autodia::Diagram::Class attributes are accessed through methods, rather than directly. Each attribute is available through calling the method of its name, ie \fBInheritances()\fR. The methods available are : .PP Operations, Attributes, Inheritances, Dependencies, Parent, and has_child. The first 4 return a list, the later return a string. .PP Adding elements to the Autodia::Diagram::Class is achieved through the add_ methods, ie \fBadd_inheritance()\fR. .PP Rather than remove an element from the diagram it is marked as redundant and replaced with a superseding element, as Autodia::Diagram::Class has highest precedence it won't be superseded and so doesn't have a \fBredundant()\fR method. Superclass and Component do. .SS "Accessing and manipulating the Autodia::Diagram::Class" .IX Subsection "Accessing and manipulating the Autodia::Diagram::Class" \&\f(CW$Class\fR\->\fBAttributes()\fR, \fBInheritances()\fR, \fBOperations()\fR, and \fBDependencies()\fR all return a list of their respective elements. .PP \&\f(CW$Class\fR\->\fBParent()\fR, and \fBhas_child()\fR return the value of the parent or child respectively if present otherwise a false. .PP \&\f(CW$Class\fR\->\fBadd_attribute()\fR, \fBadd_inheritance()\fR, \fBadd_operation()\fR, and \fBadd_dependancy()\fR all add a new element of their respective types. .SS "See Also" .IX Subsection "See Also" Autodia::DiagramObject .PP Autodia::Diagram .PP Autodia::DiagramSuperclass .PP Autodia::DiagramInheritance .SH "AUTHOR" .IX Header "AUTHOR" Aaron Trevena, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2004 by Aaron Trevena .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.1 or, at your option, any later version of Perl 5 you may have available.