Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
V
W
Y
S
schedule
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
schoolFee
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: yearly school fee for non-compulsory secondary school (pupils > 15 years).
schoolFees
- Variable in class org.cfpm.caves.za.
SouthAfricaModel.HHIncomeRecorder
sdAgeArrived
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: standard deviation of the age of in-migrants.
sdNumArrived
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: standard deviation of the number of in-migrants.
seed
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: seed for the random number generators.
setAdultEmploymentRate(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the adult employment rate
setAsHead(Person, SouthAfricaModel.EmpiricalDiscreteDist)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
helper function for populateHouseholds()
setBirthRate(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the birth rate (number of births per 1000 persons in the population)
setBurialCost(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the average cost of a burial
setChildGrant(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the monthly child grant for children up to age 7
setChildGrantAgeLimit(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the age limit for child grants.
setChildGrantProportion(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the proportion of children under the age limit who receive a child grant.
setChurchParticipationRate(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the overall church participation rate
setCollegeFee(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the yearly college/university fee.
setDateValues()
- Method in class org.cfpm.caves.za.
SouthAfricaModel
computes and sets the current date values (year, month, week)
setDensityFactor(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the density factor determining how densely the villages are populated with households (1.0 = very compact, every cell filled with a house)
setDisposalPolicy()
- Method in class org.cfpm.caves.za.
SouthAfricaModel
Jess related: define disposal policies for unneeded facts
setFoodCostChild(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the monthly food cost for a child <= 7 years old
setFoodCostFemaleAdult(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the monthly food cost for a female adult
setFoodCostMaleAdult(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the monthly food cost for a male adult
setGovernmentEmploymentRate(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the government employment rate, i.e.
setGridSizeX(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the size in dimension x of the 2D grid used as a spatial model
setGridSizeY(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the size in dimension y of the 2D grid used as a spatial model
setHouseCost(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the average cost to build a new house in the village.
setInterArrivalTime(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the mean inter-arrival time for in-migrating mine workers.
setLowerMaxNumFriends(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower limit for the maximum number of friends
setLowerMaxNumPartners(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower limit for the maximum number of concurrent sexual partners
setMaxEndorsementBase(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the maximum value for the endorsement base used in the computation of overall endorsement values.
setMaxEndorsementClasses(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the maximum number of endorsement classes.
setMaxLobola(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper bound for the lobola a groom has to pay the bride's household.
setMaxRemittance(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper bound for remittances from migrants to their household in the village
setMaxShackRent(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper limit for monthly rent of a shack in the village.
setMaxTagEvolutionPropensity(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper bound for agents' tag evolution propensity
setMeanAgeArrived(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the mean for the age distribution of in-migrants.
setMeanNumArrived(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the mean number of in-migrant mine workers arriving at one time.
setMineHIVPrevalence(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the HIV prevalence amongst in-migrating mine workers
setMinEndorsementBase(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the minimum value for the endorsement base used in the computation of overall endorsement values.
setMinEndorsementClasses(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the minimum number of endorsement classes.
setMiningTick(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the tick when mining starts in the simulation
setMinLobola(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower bound for the lobola a groom has to pay the bride's household.
setMinRemittance(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower bound for remittances from migrants to their household in the village
setMinShackRent(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower limit for monthly rent of a shack in the village.
setMinTagEvolutionPropensity(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the lower bound for agents' tag evolution propensity
setMonth(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the current month
setMotherChildHIVTransmissionRate(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the rate for mother-to-child HIV transmission.
setNeededSkilled(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets he number of skilled workers needed in the mine
setNeededUnskilled(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets he number of unskilled workers needed in the mine
setNeighbourhoodRadius(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the neighbourhood radius
setNumDenominations(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the overall number of church denominations
setNumHHAskingForFood(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the number of households asking for food during the current month
setNumHHWithoutEnoughFood(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the number of households with a lack of food even after having asked relatives/neighbours for help
setNumHouseholds(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the number of households with which to initialise the model
setNumVillages(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the number of villages
setOutputPath(String)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the output path
setPensionAgeLimitFemale(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the age limit for state pensions for female seniors.
setPensionAgeLimitMale(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the age limit for state pensions for male seniors.
setPensionProportionFemale(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the proportion of female seniors over the age limit who receive state pensions.
setPensionProportionMale(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the proportion of male seniors over the age limit who receive state pensions.
setPrintToFile(boolean)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
turns the output to file on or off
setRandomPartnerProbability(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the probability to encounter a random sexual partner
setRemittanceProbability(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the probability for sending remittance home for any migrant in any month.
setSchoolFee(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the yearly school fee for non-compulsory secondary school (pupils > 15 years).
setSdAgeArrived(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the standard deviation for the age distribution of in-migrants.
setSdNumArrived(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the standard deviation of the number of in-migrant mine workers arriving at one time.
setSeed(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the seed to be used with random generators
setShackProportion(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the proportion of households with a shack to rent out if necessary
setShowGUI(boolean)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets if the GUI is to be displayed or not
setShowOutput(boolean)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
turns the output to console on or off
setSimilarityAgeRange(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the similarity age range
setStandardWage(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the standard monthly wage (for piece jobs in the village).
setStatePension(double)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the monthly state pension for seniors.
setStopTime(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the tick when a model run stops
setTagBase(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the tag base (number of values per tag)
setTagLength(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the tag length (number of tags)
setTick(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the current tick
setup()
- Method in class org.cfpm.caves.za.
SouthAfricaModel
required by Repast: resets the model
setUpperMaxNumFriends(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper limit for the maximum number of friends
setUpperMaxNumPartners(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the upper limit for the maximum number of concurrent sexual partners
setWeek(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the current week
setYear(int)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
sets the current year
sexualNetworkRecorder
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
shackProportion
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: proportion of households in the village with a shack to rent out if necessary.
showGUI
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: flag to turn the GUI on (true) or off (false).
showOutput
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: flag to turn the output to console on (true) or off (false).
similarityAgeRange
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: age range for similarity assessment (basically, age range for friends) given as proportion of age of the agent.
sortHouseholdList(ArrayList<ArrayList<NetworkNode>>)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
helper function for locateHouseholds(): sorts household list into clusters detected in the kinship network
sortPersonList(int, int, ArrayList<Person>)
- Method in class org.cfpm.caves.za.
SouthAfricaModel
helper method for pickMigrants()
sortTypes(int[])
- Method in class org.cfpm.caves.za.
SouthAfricaModel
helper function for populateHousehold()
SouthAfricaModel
- Class in
org.cfpm.caves.za
The model class.
SouthAfricaModel()
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel
SouthAfricaModel.AgeDistributionRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.AgeDistributionRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.AgeDistributionRecorder
SouthAfricaModel.EmpiricalDiscreteDist
- Class in
org.cfpm.caves.za
This inner class defines a discrete distribution of empirical values, e.g.
SouthAfricaModel.EmpiricalDiscreteDist(double[], RandomEngine)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.EmpiricalDiscreteDist
SouthAfricaModel.EmpiricalDiscreteDistArray
- Class in
org.cfpm.caves.za
An array of discrete distributions of empirical values.
SouthAfricaModel.EmpiricalDiscreteDistArray(double[], double[][], RandomEngine)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.EmpiricalDiscreteDistArray
SouthAfricaModel.FriendshipNetworkRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.FriendshipNetworkRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.FriendshipNetworkRecorder
SouthAfricaModel.HHIncomeRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.HHIncomeRecorder()
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.HHIncomeRecorder
SouthAfricaModel.HHWealthDistRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.HHWealthDistRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.HHWealthDistRecorder
SouthAfricaModel.HHWealthDistRecorder(int[], String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.HHWealthDistRecorder
SouthAfricaModel.HIVDeathRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.HIVDeathRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.HIVDeathRecorder
SouthAfricaModel.HouseholdEconomyRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.HouseholdEconomyRecorder(ArrayList<String>, String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.HouseholdEconomyRecorder
SouthAfricaModel.MinerSource
- Class in
org.cfpm.caves.za
This inner class is a source of miners, i.e.
SouthAfricaModel.MinerSource()
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.MinerSource
creates a new MinerSource
SouthAfricaModel.MiningRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.MiningRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.MiningRecorder
SouthAfricaModel.PartnershipRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.PartnershipRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.PartnershipRecorder
SouthAfricaModel.SexualNetworkRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.SexualNetworkRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.SexualNetworkRecorder
SouthAfricaModel.StokvelRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.StokvelRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.StokvelRecorder
SouthAfricaModel.VillageEconomyRecorder
- Class in
org.cfpm.caves.za
SouthAfricaModel.VillageEconomyRecorder(String, SouthAfricaModel)
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.VillageEconomyRecorder
SouthAfricaModel.WHOLifeTable
- Class in
org.cfpm.caves.za
This class represents a life table as produced by the WHO.
SouthAfricaModel.WHOLifeTable(int[], double[])
- Constructor for class org.cfpm.caves.za.
SouthAfricaModel.WHOLifeTable
space
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
the 2D grid used as a representation of space
spaceDisplay
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
stageDist
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
standardWage
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: monthly wage within village.
statePension
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: monthly state pension for seniors.
stokvelNetwork
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
stokvelNetworkDisplay
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
stokvelRecorder
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
stokvels
- Variable in class org.cfpm.caves.za.
SouthAfricaModel.StokvelRecorder
stopTime
- Variable in class org.cfpm.caves.za.
SouthAfricaModel
model parameter: tick to stop the simulation run.
supplyGrants()
- Method in class org.cfpm.caves.za.
SouthAfricaModel
Supply households with state grants: child grants for children < 7 and pensions for registered pensioners.
Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
V
W
Y