Pedigree::MarriageNode(3)

NAME
Pedigree::MarriageNode - a marriage in a pedigree

SYNOPSIS
use Pedigree::MarriageNode;

$node = new Pedigree::MarriageNode(%params);

$FSpouse = $node->FSpouse();

$MSpouse = $node->MSpouse();

$consang = $self->isConsanguinic();

$area = $node->SetArea();

$node->CalcAbsCoord($x, $y);

$node->DrawNode($xidst, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);

$node->DrawConnections();

DESCRIPTION
This package contains data about a marriage.

new(%params);
    Construct a new node from the given parameters.

FSpouse();
    Get female spouse of a node.

MSpouse();
    Get female spouse of a node.

isConsanguinic();
    Check whether the node is consanguinic

SetArea();
    Calculate relative coordinates for all nodes, that are descendants of the given node and the spouses that form the marriage. We create a Pedigree::Area(3) around the given node and recursively apply the function to all descendants. The subroutine returns the reference to the created area.

CalcAbsCoor($x, $<y>);
    Set the absolute coordinates of the given node, if the absolute coordinates of the parent node are ($x, $y), and recursively do this for all descendants of this node, and right and left clumps.

DrawNode($xdist, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);
    Output the command to draw this node. The parameters are distances between the nodes (in cm).

DrawConnections();
    Draw the connections from the given node to its descendants and the spouses

ENVIRONMENT
The calling program should define $main::DEBUG and set it to 0 or 1.

SEE ALSO
pedigree(1), Pedigree(3)

AUTHOR
Boris Veytsman, Leila Akhmadeeva, 2006, 2007