org.mars_sim.msp.core.person.ai.mission
Class Trade

java.lang.Object
  org.mars_sim.msp.core.person.ai.mission.Mission
      org.mars_sim.msp.core.person.ai.mission.TravelMission
          org.mars_sim.msp.core.person.ai.mission.VehicleMission
              org.mars_sim.msp.core.person.ai.mission.RoverMission
                  org.mars_sim.msp.core.person.ai.mission.Trade

All Implemented Interfaces:

Serializable, UnitListener

public class Trade
extends RoverMission
implements Serializable

A mission for trading between two settlements.

See Also:

Serialized Form

Field Summary

static String	BUY_LOAD_EVENT
static String	DEFAULT_DESCRIPTION
static String	LOAD_GOODS
static String	TRADE_DISEMBARKING
static String	TRADE_EMBARKING
static String	TRADE_NEGOTIATING
static String	UNLOAD_GOODS

Fields inherited from class org.mars_sim.msp.core.person.ai.mission.RoverMission

MIN_PEOPLE, STARTING_SETTLEMENT_EVENT

Fields inherited from class org.mars_sim.msp.core.person.ai.mission.VehicleMission

DISEMBARKING, EMBARKING, equipmentNeededCache, loadedFlag, OPERATOR_EVENT, TRAVELLING, VEHICLE_EVENT

Fields inherited from class org.mars_sim.msp.core.person.ai.mission.TravelMission

AT_NAVPOINT, DISTANCE_EVENT, NAVPOINTS_EVENT, TRAVEL_STATUS_EVENT, TRAVEL_TO_NAVPOINT

Fields inherited from class org.mars_sim.msp.core.person.ai.mission.Mission

ADD_MEMBER_EVENT, ASSOCIATED_SETTLEMENT_EVENT, CAPACITY_EVENT, DESCRIPTION_EVENT, END_MISSION_EVENT, MIN_PEOPLE_EVENT, NAME_EVENT, PHASE_DESCRIPTION_EVENT, PHASE_EVENT, REMOVE_MEMBER_EVENT

Constructor Summary

Trade(Collection<Person> members, Settlement startingSettlement, Settlement tradingSettlement, Rover rover, String description, Map<Good,Integer> sellGoods, Map<Good,Integer> buyGoods)
Constructor with explicit data.

Trade(Person startingPerson)
Constructor.

Method Summary

protected int	compareVehicles(Vehicle firstVehicle, Vehicle secondVehicle) Compares the quality of two vehicles for use in this mission.
void	destroy() Prepare object for garbage collection.
protected void	determineNewPhase() Determines a new phase for the mission when the current phase has ended.
void	endMission(String reason) Finalizes the mission
Settlement	getAssociatedSettlement() Gets the settlement associated with the mission.
Map<Good,Integer>	getBuyLoad() Gets the load that is being bought in the trade.
Map<Good,Integer>	getDesiredBuyLoad() Gets the load that the starting settlement initially desires to buy.
double	getDesiredProfit() Gets the profit initially expected by the starting settlement.
Map<Class,Integer>	getEquipmentNeededForRemainingMission(boolean useBuffer) Gets the number and types of equipment needed for the mission.
static double	getNewMissionProbability(Person person) Gets the weighted probability that a given person would start this mission.
Map<Class,Integer>	getOptionalEquipmentToLoad() Gets the optional equipment needed for loading the vehicle.
Map<Resource,Number>	getOptionalResourcesToLoad() Gets the optional resources needed for loading the vehicle.
double	getProfit() Gets the profit for the settlement initiating the trade.
Map<Good,Integer>	getSellLoad() Gets the load that is being sold in the trade.
Settlement	getTradingSettlement() Gets the settlement that the starting settlement is trading with.
protected boolean	isCapableOfMission(Person person) Checks to see if a person is capable of joining a mission.
protected void	performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement) Performs the disembark to settlement phase of the mission.
protected void	performEmbarkFromSettlementPhase(Person person) Performs the embark from settlement phase of the mission.
protected void	performPhase(Person person) The person performs the current phase of the mission.
protected void	recruitPeopleForMission(Person startingPerson) Recruits new people into the mission.

Methods inherited from class org.mars_sim.msp.core.person.ai.mission.RoverMission

areVehiclesAvailable, atLeastOnePersonRemainingAtSettlement, getOperateVehicleTask, getResourcesNeededForTrip, getRover, getStartingSettlement, getVehicleWithGreatestRange, hasBackupRover, hasDangerousMedicalProblemAtAssociatedSettlement, hasEmergency, hasEnoughBasicResources, isEveryoneInRover, isNoOneInRover, isRoverInAGarage, isUsableVehicle, minAvailablePeopleAtSettlement, setStartingSettlement

Methods inherited from class org.mars_sim.msp.core.person.ai.mission.VehicleMission

determineEmergencyDestination, findClosestSettlement, getAverageVehicleSpeedForOperators, getEstimatedRemainingMissionTime, getEstimatedTripTime, getFuelNeededForTrip, getLegETA, getPartsNeededForTrip, getRequiredEquipmentToLoad, getRequiredResourcesToLoad, getResourcesNeededForRemainingMission, getTotalDistanceTravelled, getVehicle, hasEmbarkingMissions, hasEnoughResourcesForRemainingMission, hasVehicle, isVehicleLoadable, isVehicleLoaded, leaveVehicle, performTravelPhase, reserveVehicle, setEmergencyBeacon, setVehicle, timePassing, unitUpdate, updateTravelDestination

Methods inherited from class org.mars_sim.msp.core.person.ai.mission.TravelMission

addNavpoint, clearRemainingNavpoints, getCurrentLegDistance, getCurrentLegRemainingDistance, getCurrentLegStartingTime, getCurrentNavpoint, getCurrentNavpointIndex, getNavpoint, getNavpointIndex, getNextNavpoint, getNextNavpointIndex, getNumberOfNavpoints, getPreviousNavpoint, getTotalDistance, getTotalRemainingDistance, getTravelStatus, reachedNextNode, setNavpoint, setNextNavpointIndex, startTravelToNextNode

Methods inherited from class org.mars_sim.msp.core.person.ai.mission.Mission

addMissionListener, addPerson, addPhase, assignTask, associateAllMembersWithSettlement, fireMissionUpdate, fireMissionUpdate, getCurrentMissionLocation, getDescription, getMinPeople, getMissionCapacity, getMissionQualification, getName, getPeople, getPeopleNumber, getPhase, getPhaseDescription, getPhaseEnded, hasDangerousMedicalProblems, hasDangerousMedicalProblemsAllCrew, hasEmergencyAllCrew, hasPerson, isDone, performMission, removeMissionListener, removePerson, setDescription, setMinPeople, setMissionCapacity, setName, setPhase, setPhaseDescription, setPhaseEnded, toString

Methods inherited from class java.lang.Object

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

Field Detail

BUY_LOAD_EVENT

public static final String BUY_LOAD_EVENT

See Also:

Constant Field Values

DEFAULT_DESCRIPTION

public static final String DEFAULT_DESCRIPTION

See Also:

Constant Field Values

TRADE_DISEMBARKING

public static final String TRADE_DISEMBARKING

See Also:

Constant Field Values

TRADE_NEGOTIATING

public static final String TRADE_NEGOTIATING

See Also:

Constant Field Values

UNLOAD_GOODS

public static final String UNLOAD_GOODS

See Also:

Constant Field Values

LOAD_GOODS

public static final String LOAD_GOODS

See Also:

Constant Field Values

TRADE_EMBARKING

public static final String TRADE_EMBARKING

See Also:

Constant Field Values

Constructor Detail

Trade

public Trade(Person startingPerson)

Constructor.

Parameters:

startingPerson - the person starting the settlement.

Throws:

MissionException - if error constructing mission.

Trade

public Trade(Collection<Person> members,
             Settlement startingSettlement,
             Settlement tradingSettlement,
             Rover rover,
             String description,
             Map<Good,Integer> sellGoods,
             Map<Good,Integer> buyGoods)

Constructor with explicit data.

Parameters:

members - collection of mission members.

startingSettlement - the starting settlement.

tradingSettlement - the trading settlement.

rover - the rover to use.

description - the mission's description.

sellGoods - map of mission sell goods and integer amounts.

buyGoods - map of mission buy goods and integer amounts

Throws:

MissionException - if error constructing mission.

Method Detail

getNewMissionProbability

public static double getNewMissionProbability(Person person)

Gets the weighted probability that a given person would start this mission.

Parameters:

person - the given person

Returns:

the weighted probability

determineNewPhase

protected void determineNewPhase()

Determines a new phase for the mission when the current phase has ended.

Overrides:

determineNewPhase in class VehicleMission

Throws:

MissionException - if problem setting a new phase.

performPhase

protected void performPhase(Person person)

The person performs the current phase of the mission.

Overrides:

performPhase in class RoverMission

Parameters:

person - the person performing the phase.

Throws:

MissionException - if problem performing the phase.

performEmbarkFromSettlementPhase

protected void performEmbarkFromSettlementPhase(Person person)

Performs the embark from settlement phase of the mission.

Overrides:

performEmbarkFromSettlementPhase in class RoverMission

Parameters:

person - the person currently performing the mission

Throws:

MissionException - if error performing phase.

performDisembarkToSettlementPhase

protected void performDisembarkToSettlementPhase(Person person,
                                                 Settlement disembarkSettlement)

Performs the disembark to settlement phase of the mission.

Overrides:

performDisembarkToSettlementPhase in class RoverMission

Parameters:

person - the person currently performing the mission.

disembarkSettlement - the settlement to be disembarked to.

Throws:

MissionException - if error performing phase.

endMission

public void endMission(String reason)

Description copied from class: VehicleMission

Finalizes the mission

Overrides:

endMission in class RoverMission

Parameters:

reason - the reason of ending the mission.

getOptionalEquipmentToLoad

public Map<Class,Integer> getOptionalEquipmentToLoad()

Description copied from class: VehicleMission

Gets the optional equipment needed for loading the vehicle.

Overrides:

getOptionalEquipmentToLoad in class VehicleMission

Returns:

equipment and their number.

getOptionalResourcesToLoad

public Map<Resource,Number> getOptionalResourcesToLoad()

Description copied from class: VehicleMission

Gets the optional resources needed for loading the vehicle.

Overrides:

getOptionalResourcesToLoad in class VehicleMission

Returns:

resources and their number.

getAssociatedSettlement

public Settlement getAssociatedSettlement()

Gets the settlement associated with the mission.

Specified by:

getAssociatedSettlement in class Mission

Returns:

settlement or null if none.

isCapableOfMission

protected boolean isCapableOfMission(Person person)

Checks to see if a person is capable of joining a mission.

Overrides:

isCapableOfMission in class Mission

Parameters:

person - the person to check.

Returns:

true if person could join mission.

recruitPeopleForMission

protected void recruitPeopleForMission(Person startingPerson)

Recruits new people into the mission.

Overrides:

recruitPeopleForMission in class Mission

Parameters:

startingPerson - the person starting the mission.

compareVehicles

protected int compareVehicles(Vehicle firstVehicle,
                              Vehicle secondVehicle)

Compares the quality of two vehicles for use in this mission.

Overrides:

compareVehicles in class VehicleMission

Parameters:

firstVehicle - the first vehicle to compare

secondVehicle - the second vehicle to compare

Returns:

-1 if the second vehicle is better than the first vehicle, 0 if vehicle are equal in quality, and 1 if the first vehicle is better than the second vehicle.

Throws:

IllegalArgumentException - if firstVehicle or secondVehicle is null.

MissionException - if error comparing vehicles.

getSellLoad

public Map<Good,Integer> getSellLoad()

Gets the load that is being sold in the trade.

Returns:

sell load.

getBuyLoad

public Map<Good,Integer> getBuyLoad()

Gets the load that is being bought in the trade.

Returns:

buy load.

getProfit

public double getProfit()

Gets the profit for the settlement initiating the trade.

Returns:

profit (VP).

getDesiredBuyLoad

public Map<Good,Integer> getDesiredBuyLoad()

Gets the load that the starting settlement initially desires to buy.

Returns:

desired buy load.

getDesiredProfit

public double getDesiredProfit()

Gets the profit initially expected by the starting settlement.

Returns:

desired profit (VP).

getTradingSettlement

public Settlement getTradingSettlement()

Gets the settlement that the starting settlement is trading with.

Returns:

trading settlement.

destroy

public void destroy()

Description copied from class: Mission

Prepare object for garbage collection.

Overrides:

destroy in class RoverMission

getEquipmentNeededForRemainingMission

public Map<Class,Integer> getEquipmentNeededForRemainingMission(boolean useBuffer)

Description copied from class: Mission

Gets the number and types of equipment needed for the mission.

Specified by:

getEquipmentNeededForRemainingMission in class Mission

Parameters:

useBuffer - use time buffers in estimation if true.

Returns:

map of equipment class and Integer number.