uk.ac.leeds.ccg.andyt.projects.genesis.core
Class GENESIS_Female

java.lang.Object
  uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Agent
      uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Person
          uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Female

All Implemented Interfaces:

java.io.Serializable

public class GENESIS_Female
extends GENESIS_Person

See Also:

Serialized Form

Nested Class Summary

class

GENESIS_Female.Miscarriage

Field Summary

int[]	_GenderOfUnborns The length of this indicates if a single baby birth is expected or if there are twins or other multiple births.
protected GENESIS_FemaleCollection	_GENESIS_FemaleCollection A reference to the main GENESIS_FemaleCollection to which this belongs
int	_LengthOfFertilityPeriod
java.util.TreeSet<GENESIS_Female.Miscarriage>	_Miscarriages For storing information about miscarriages.
int	_StartOfFertiliyPeriod
GENESIS_Time	_Time_DueToGiveBirth Expected due date.
static java.math.BigDecimal	NormalGestationPeriod_BigDecimal
static int	NormalGestationPeriod_int Gestation period in humans taken as 266 days http://en.wikipedia.org/wiki/Gestation_period If _Time_DueToGiveBirth != null then female is pregnant

Fields inherited from class uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Person

_Age, _Birth_Calendar, _Birth_Point2D, _Collection_ID, _Death_Point2D, _Death_Time, _Directory, _Family, _Heading_Point2D, _Household, _HouseholdHistory, _ID, _Movement, _Network2D, _personalFertility_BigDecimal, _personalMortality_BigDecimal, _Point2D, _Previous_Point2D, _reporting_CellID, _reporting_VectorNetwork2D, _ResidentialSubregionIDs, _resource_double, _resourceMax_double, _SetOffToWork_0_Time, _SetOffToWork_Time, _Speed_BigDecimal, _Speed_double, _SpeedDefault_BigDecimal, _SpeedDefault_double, _Work_Point2D, _Work_Time

Fields inherited from class uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Agent

_GENESIS_AgentCollectionManager, _GENESIS_Environment, _Type

Constructor Summary

protected	GENESIS_Female(GENESIS_Environment a_GENESIS_Environment, GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager, java.io.File _Directory, GENESIS_Age age, Household _Household, uk.ac.leeds.ccg.andyt.vector.geometry.Vector_Point2D _Point2D)
protected	GENESIS_Female(GENESIS_Environment a_GENESIS_Environment, GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager, GENESIS_Age age)
protected	GENESIS_Female(GENESIS_Environment a_GENESIS_Environment, GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager, GENESIS_Age age, Household _Household)
protected	GENESIS_Female(GENESIS_Environment a_GENESIS_Environment, GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager, GENESIS_Age age, Household _Household, uk.ac.leeds.ccg.andyt.vector.geometry.Vector_Point2D _Point2D)

Method Summary

java.lang.Long	get_Agent_ID(boolean handleOutOfMemoryError)
protected GENESIS_AgentCollection	get_AgentCollection()
protected java.io.File	get_Directory() Deprecated.
protected java.lang.Long	get_Female_ID()
protected java.lang.Long	get_FemaleCollection_ID()
java.lang.Long	get_FemaleCollection_ID(boolean handleOutOfMemoryError)
protected GENESIS_FemaleCollection	get_FemaleCollection()
GENESIS_FemaleCollection	get_FemaleCollection(boolean handleOutOfMemoryError)
protected int	get_Gender()
int	get_Gender(boolean handleOutOfMemoryError)
java.lang.Integer	getDaysToDueDate()
protected java.lang.Object[]	giveBirthSimple() Sets _Time_DueToGiveBirth and _GenderOfUnborns to null.
java.lang.Object[]	giveBirthSimple(boolean handleOutOfMemoryError) Sets _Time_DueToGiveBirth and _GenderOfUnborns to null.
protected GENESIS_Person[]	giveBirthSimpleOld() Deprecated.
GENESIS_Person[]	giveBirthSimpleOld(boolean handleOutOfMemoryError) Deprecated.
void	init_Miscarriages()
protected void	init(GENESIS_Environment a_GENESIS_Environment, java.lang.Long _Female_ID, java.lang.Long _FemaleCollection_ID)
protected boolean	isPregnant()
boolean	isPregnant(boolean handleOutOfMemoryError)
void	miscarriage()
static GENESIS_Female	read(long a_Agent_ID, GENESIS_FemaleCollection a_GENESIS_FemaleCollection) Deprecated.
protected void	set_Pregnant(GENESIS_Fertility a_Fertility) This sets the due date assuming 266 day gestation.
void	set_Pregnant(GENESIS_Fertility a_Fertility, boolean handleOutOfMemoryError) This sets the due date assuming 266 day gestation.
protected boolean	set_Pregnant(GENESIS_Fertility a_Fertility, int numberOfDaysUntilDue) This sets the due date assuming 266 day gestation, but that pregnancy is already at day days.
boolean	set_Pregnant(GENESIS_Fertility a_Fertility, int numberOfDaysUntilDue, boolean handleOutOfMemoryError) This sets the due date assuming 266 day gestation, but that pregnancy is already at day days.
java.lang.String	toString()
protected void	write() Deprecated.
void	write(boolean handleOutOfMemoryError) Deprecated.

Methods inherited from class uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Person

get_Age, get_Previous_Point2D, get_Work_Time, getAge, getIsBirthday, getIsTimeToSetOfToWork, getIsWorkTime, getNextConnectionOnRoute, getPreviousRegionID, getPreviousSubregionID, getRegionID, getSubregionID, getTypeDeadFemale_String, getTypeDeadMale_String, getTypeLivingFemale_String, getTypeLivingMale_String, init, isAlive, log, log, move, move, move, set_Death_Time, set_Heading_Point2D, set_Previous_Point2D, setMovement

Methods inherited from class uk.ac.leeds.ccg.andyt.projects.genesis.core.GENESIS_Agent

get_AgentCollectionManager, getType, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NormalGestationPeriod_int

public static final int NormalGestationPeriod_int

Gestation period in humans taken as 266 days http://en.wikipedia.org/wiki/Gestation_period If _Time_DueToGiveBirth != null then female is pregnant

See Also:

Constant Field Values

NormalGestationPeriod_BigDecimal

public static final java.math.BigDecimal NormalGestationPeriod_BigDecimal

_GENESIS_FemaleCollection

protected transient GENESIS_FemaleCollection _GENESIS_FemaleCollection

A reference to the main GENESIS_FemaleCollection to which this belongs

_GenderOfUnborns

public int[] _GenderOfUnborns

The length of this indicates if a single baby birth is expected or if there are twins or other multiple births. It also indicates the gender at birth.

_Time_DueToGiveBirth

public GENESIS_Time _Time_DueToGiveBirth

Expected due date. If this is set then isPregnant() returns true.

_Miscarriages

public java.util.TreeSet<GENESIS_Female.Miscarriage> _Miscarriages

For storing information about miscarriages.

_LengthOfFertilityPeriod

public int _LengthOfFertilityPeriod

_StartOfFertiliyPeriod

public int _StartOfFertiliyPeriod

Constructor Detail

GENESIS_Female

protected GENESIS_Female(GENESIS_Environment a_GENESIS_Environment,
                         GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager,
                         GENESIS_Age age)

GENESIS_Female

protected GENESIS_Female(GENESIS_Environment a_GENESIS_Environment,
                         GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager,
                         GENESIS_Age age,
                         Household _Household)

GENESIS_Female

protected GENESIS_Female(GENESIS_Environment a_GENESIS_Environment,
                         GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager,
                         GENESIS_Age age,
                         Household _Household,
                         uk.ac.leeds.ccg.andyt.vector.geometry.Vector_Point2D _Point2D)

GENESIS_Female

protected GENESIS_Female(GENESIS_Environment a_GENESIS_Environment,
                         GENESIS_AgentCollectionManager a_GENESIS_AgentCollectionManager,
                         java.io.File _Directory,
                         GENESIS_Age age,
                         Household _Household,
                         uk.ac.leeds.ccg.andyt.vector.geometry.Vector_Point2D _Point2D)

Method Detail

init

protected final void init(GENESIS_Environment a_GENESIS_Environment,
                          java.lang.Long _Female_ID,
                          java.lang.Long _FemaleCollection_ID)

toString

public java.lang.String toString()

Overrides:

toString in class GENESIS_Person

Returns:

description of this.

get_Female_ID

protected java.lang.Long get_Female_ID()

Returns:

A copy of this._Agent_ID

get_Agent_ID

public java.lang.Long get_Agent_ID(boolean handleOutOfMemoryError)

Specified by:

get_Agent_ID in class GENESIS_Agent

get_AgentCollection

protected GENESIS_AgentCollection get_AgentCollection()

Specified by:

get_AgentCollection in class GENESIS_Agent

Returns:

this._GENESIS_AgentEnvironment._GENESIS_AgentCollectionManager.getAgentCollection(_AgentCollection_ID)

get_FemaleCollection

public GENESIS_FemaleCollection get_FemaleCollection(boolean handleOutOfMemoryError)

get_FemaleCollection

protected GENESIS_FemaleCollection get_FemaleCollection()

get_FemaleCollection_ID

public java.lang.Long get_FemaleCollection_ID(boolean handleOutOfMemoryError)

get_FemaleCollection_ID

protected java.lang.Long get_FemaleCollection_ID()

get_Gender

public int get_Gender(boolean handleOutOfMemoryError)

Specified by:

get_Gender in class GENESIS_Person

get_Gender

protected int get_Gender()

Specified by:

get_Gender in class GENESIS_Person

getDaysToDueDate

public java.lang.Integer getDaysToDueDate()

set_Pregnant

public boolean set_Pregnant(GENESIS_Fertility a_Fertility,
                            int numberOfDaysUntilDue,
                            boolean handleOutOfMemoryError)

This sets the due date assuming 266 day gestation, but that pregnancy is already at day days. Sets the number and gender of unborns.

set_Pregnant

protected boolean set_Pregnant(GENESIS_Fertility a_Fertility,
                               int numberOfDaysUntilDue)

This sets the due date assuming 266 day gestation, but that pregnancy is already at day days. Sets the number and gender of unborns.

set_Pregnant

public void set_Pregnant(GENESIS_Fertility a_Fertility,
                         boolean handleOutOfMemoryError)

This sets the due date assuming 266 day gestation. Sets the number and gender of unborns.

set_Pregnant

protected void set_Pregnant(GENESIS_Fertility a_Fertility)

This sets the due date assuming 266 day gestation. Sets the number and gender of unborns.

isPregnant

public boolean isPregnant(boolean handleOutOfMemoryError)

isPregnant

protected boolean isPregnant()

init_Miscarriages

public void init_Miscarriages()

miscarriage

public void miscarriage()

giveBirthSimple

public java.lang.Object[] giveBirthSimple(boolean handleOutOfMemoryError)

Sets _Time_DueToGiveBirth and _GenderOfUnborns to null. Creates new people given _GenderOfUnborns and returns an Object with three elements: HashSet babyGirl_IDs, HashSet babyBoy_IDs, Integer of the number of babies born.

giveBirthSimpleOld

@Deprecated
public GENESIS_Person[] giveBirthSimpleOld(boolean handleOutOfMemoryError)

Deprecated.

Sets _Time_DueToGiveBirth and _GenderOfUnborns to null. Creates new people given _GenderOfUnborns and returns an Object with three elements: HashSet babyGirl_IDs, HashSet babyBoy_IDs, Integer of the number of babies born.

giveBirthSimple

protected java.lang.Object[] giveBirthSimple()

Sets _Time_DueToGiveBirth and _GenderOfUnborns to null. Creates new people given _GenderOfUnborns and returns an Object with three elements: HashSet babyGirl_IDs, HashSet babyBoy_IDs, Integer of the number of babies born.

giveBirthSimpleOld

@Deprecated
protected GENESIS_Person[] giveBirthSimpleOld()

Deprecated.

Sets _Time_DueToGiveBirth and _GenderOfUnborns to null. Creates and returns a GENESIS_Person[] of newborns.

Returns:

Array containing newborns

read

@Deprecated
public static GENESIS_Female read(long a_Agent_ID,
                                             GENESIS_FemaleCollection a_GENESIS_FemaleCollection)

Deprecated.

write

@Deprecated
public void write(boolean handleOutOfMemoryError)

Deprecated.

Specified by:

write in class GENESIS_Agent

write

@Deprecated
protected void write()

Deprecated.

Specified by:

write in class GENESIS_Agent

get_Directory

@Deprecated
protected java.io.File get_Directory()

Deprecated.

Specified by:

get_Directory in class GENESIS_Agent