PyPedal::pyp_newclasses::NewAnimal Class Reference

The NewAnimal() class is holds animals records read from a pedigree file. More...

List of all members.

Public Member Functions

def __init__
 __init__() initializes a NewAnimal() object.
def printme
 printme() prints a summary of the data stored in the NewAnimal() object.
def stringme
 stringme() returns a summary of the data stored in the NewAnimal() object as a string.
def dictme
 dictme() returns a summary of the data stored in the NewAnimal() object as a dictionary.
def trap
 trap() checks for common errors in NewAnimal() objects
def pad_id
 pad_id() takes an Animal ID, pads it to fifteen digits, and prepends the birthyear (or 1950 if the birth year is unknown).
def string_to_int
 string_to_int() takes an Animal/Sire/Dam ID as a string and returns a hash.

Public Attributes

 name
 animalID
 originalID
 sireID
 sireName
 damID
 damName
 gen
 gencoeff
 sex
 bd
 by
 fa
 breed
 age
 alive
 herd
 originalHerd
 renumberedID
 igen
 founder
 paddedID
 ancestor
 sons
 daus
 unks
 alleles
 pedcomp
 userField


Detailed Description

The NewAnimal() class is holds animals records read from a pedigree file.

A simple class to hold animals records read from a pedigree file.

Definition at line 1708 of file pyp_newclasses.py.


Member Function Documentation

def PyPedal::pyp_newclasses::NewAnimal::__init__ (   self,
  locations,
  data,
  mykw 
)

__init__() initializes a NewAnimal() object.

Parameters:
locations A dictionary containing the locations of variables in the input line.
data The line of input read from the pedigree file.
Returns:
An instance of a NewAnimal() object populated with data object
__init__() initializes a NewAnimal() object.

Definition at line 1716 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::printme (   self  ) 

printme() prints a summary of the data stored in the NewAnimal() object.

Parameters:
self Reference to the current NewAnimal() object
Print the contents of an animal record - used for debugging.

Definition at line 1872 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::stringme (   self  ) 

stringme() returns a summary of the data stored in the NewAnimal() object as a string.

Parameters:
self Reference to the current NewAnimal() object
Return the contents of an animal record as a string.

Definition at line 1908 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::dictme (   self  ) 

dictme() returns a summary of the data stored in the NewAnimal() object as a dictionary.

Parameters:
self Reference to the current NewAnimal() object
Return the contents of an animal record in a dictionary.

Definition at line 1947 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::trap (   self  ) 

trap() checks for common errors in NewAnimal() objects

Parameters:
self Reference to the current NewAnimal() object
Trap common errors in pedigree file entries.

Definition at line 1987 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::pad_id (   self  ) 

pad_id() takes an Animal ID, pads it to fifteen digits, and prepends the birthyear (or 1950 if the birth year is unknown).

The order of elements is: birthyear, animalID, count of zeros, zeros.

Parameters:
self Reference to the current NewAnimal() object
Returns:
A padded ID number that is supposed to be unique across animals integer
Take an Animal ID, pad it to fifteen digits, and prepend the birthyear (or 1900
if the birth year is unknown).  The order of elements is: birthyear, animalID,
count of zeros, zeros.

Definition at line 2006 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::NewAnimal::string_to_int (   self,
  idstring,
  mymaxint = 9223372036854775807 
)

string_to_int() takes an Animal/Sire/Dam ID as a string and returns a hash.

Convert a string to an integer.

Definition at line 2025 of file pyp_newclasses.py.


The documentation for this class was generated from the following file:

Generated on Thu May 1 12:33:44 2008 for PyPedal by  doxygen 1.5.5