summaryrefslogtreecommitdiff
path: root/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/PersonNode.3
blob: 8876211f5366a4c98000a7e2fb12481923a6848a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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::PersonNode 3"
.TH Pedigree::PersonNode 3 "2007-07-22" "perl v5.10.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"
Pedigree::PersonNode \- a person in a pedigree
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use Pedigree::PersonNode;
.PP
\&\f(CW$node\fR = new Pedigree::PersonNode(\fI\f(CI%params\fI\fR);
.PP
\&\f(CW$Id\fR = \f(CW$node\fR\->\fIMotherId()\fR;
\&\f(CW$Id\fR = \f(CW$node\fR\->\fIFatherId()\fR;
.PP
\&\f(CW$isProband\fR = \f(CW$node\fR\->\fIisProband()\fR;
.PP
\&\f(CW$sex\fR = \f(CW$node\fR\->\fISex()\fR;
.PP
\&\f(CW$DoB\fR = \f(CW$node\fR\->\fIDoB()\fR;
.PP
\&\f(CW$DoD\fR = \f(CW$node\fR\->\fIDoD()\fR;
.PP
\&\f(CW$cond\fR = \f(CW$node\fR\->\fICondition()\fR;
.PP
\&\f(CW$GenName\fR = \f(CW$node\fR\->\fIGetGenName()\fR;
.PP
\&\f(CW$node\fR\->SetGenName(\fI\f(CI$name\fI\fR);
.PP
\&\f(CW$node\fR\->DrawNode(\fI\f(CI$xidst\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR, 
\&\fI\f(CI@fieldsfornode\fI\fR);
.PP
\&\f(CW$node\fR\->PrintLegend(\fI\f(CI$land\fI\fR, \fI\f(CI@fields\fI\fR);
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package contains data about a person.
.Sp
.RS 4
\&\fBnew\fR(\fI\f(CI%params\fI\fR);
.Sp
Construct a new node from the given parameters.
.Sp
\&\fBMotherId\fR();
.Sp
Return Mother Id.
.Sp
\&\fBFatherId\fR();
.Sp
Return Father Id.
.Sp
\&\fBisProband\fR();
.Sp
Return 1 if the pesron is a Proband and zero otherwise
.Sp
\&\fBSex\fR();
.Sp
Get the sex of the node
.Sp
\&\fBDoB\fR();
.Sp
Get the DoB of the node
.Sp
\&\fBDoD\fR();
.Sp
Get the DoB of the node
.Sp
\&\fBCondition\fR();
.Sp
Returns node conditon.
.Sp
\&\fBGetGenName\fR();
.Sp
Find the generation name for the node
.Sp
\&\fBSetGenName\fR(\fI\f(CI$name\fI\fR);
.Sp
Set the generation name of the node
.Sp
\&\fBDrawNode\fR(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR,
\&\fI\f(CI@fieldsfornode\fI\fR);
.Sp
Output the command to draw this node.  The parameters are
distances between the nodes (in cm) and fields for abovetext.
.Sp
\&\fBPrintLegend\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR);
.Sp
Print the legend for the given node, including \fI\f(CI@fields\fI\fR in the given
language \fI\f(CI$lang\fI\fR.
.RE
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The calling program should define \fB\f(CB$main::DEBUG\fB\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
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 39:" 4
.IX Item "Around line 39:"
You can't have =items (as at line 58) unless the first thing after the =over is an =item