diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3')
-rw-r--r-- | Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 new file mode 100644 index 00000000000..d36edd4a56c --- /dev/null +++ b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 @@ -0,0 +1,199 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.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" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "Pedigree::MarriageNode 3" +.TH Pedigree::MarriageNode 3 "2007-07-15" "perl v5.8.8" "User Contributed Perl Documentation" +.SH "NAME" +Pedigree::MarriageNode \- a marriage in a pedigree +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +use Pedigree::MarriageNode; +.PP +$node = new Pedigree::MarriageNode(\fI%params\fR); +.PP +$FSpouse = \f(CW$node\fR\->\fIFSpouse()\fR; +.PP +$MSpouse = \f(CW$node\fR\->\fIMSpouse()\fR; +.PP +$consang = \f(CW$self\fR\->\fIisConsanguinic()\fR; +.PP +$area = \f(CW$node\fR\->\fISetArea()\fR; +.PP +$node\->CalcAbsCoord(\fI$x\fR, \fI$y\fR); +.PP +$node\->DrawNode(\fI$xidst\fR, \fI$ydist\fR, \fI$belowtextfont\fR, \fI$abovetextfont\fR, +\&\fI@fieldsfornode\fR); +.PP +$node\->\fIDrawConnections()\fR; +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This package contains data about a marriage. +.IP "\fBnew\fR(\fI%params\fR);" 4 +.IX Item "new(%params);" +Construct a new node from the given parameters. +.IP "\fBFSpouse\fR();" 4 +.IX Item "FSpouse();" +Get female spouse of a node. +.IP "\fBMSpouse\fR();" 4 +.IX Item "MSpouse();" +Get female spouse of a node. +.IP "\fBisConsanguinic\fR();" 4 +.IX Item "isConsanguinic();" +Check whether the node is consanguinic +.IP "\fBSetArea\fR();" 4 +.IX Item "SetArea();" +Calculate relative coordinates for all nodes, that are descendants of +the given node \fIand\fR the spouses that form the marriage. We create a +\&\fIPedigree::Area\fR\|(3) around the given node and recursively apply the +function to all descendants. The subroutine +returns the reference to the created area. +.IP "\fBCalcAbsCoor\fR(\fI$x\fR, $<y>);" 4 +.IX Item "CalcAbsCoor($x, $<y>);" +Set the absolute coordinates of the given node, if the absolute +coordinates of the parent node are (\fI$x\fR, \fI$y\fR), and recursively +do this for all descendants of this node, and right and left clumps. +.IP "\fBDrawNode\fR(\fI$xdist\fR, \fI$ydist\fR, \fI$belowtextfont\fR, \fI$abovetextfont\fR, \fI@fieldsfornode\fR);" 4 +.IX Item "DrawNode($xdist, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);" +Output the command to draw this node. The parameters are +distances between the nodes (in cm). +.IP "\fBDrawConnections\fR();" 4 +.IX Item "DrawConnections();" +Draw the connections from the given node to its descendants and +the spouses +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +The calling program should define \fB$main::DEBUG\fR and set it to 0 +or 1. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIpedigree\fR\|(1), \fIPedigree\fR\|(3) +.SH "AUTHOR" +.IX Header "AUTHOR" +Boris Veytsman, Leila Akhmadeeva, 2006, 2007 |