Stride Reference Manual  1.0
stride::AsyncSimulator Class Referenceabstract

#include <AsyncSimulator.h>

Inheritance diagram for stride::AsyncSimulator:
Inheritance graph
Collaboration diagram for stride::AsyncSimulator:
Collaboration graph

Public Member Functions

virtual string getName () const =0
 
virtual future< SimulatorStatustimeStep ()=0
 
virtual void welcomeHomeTravellers (const pair< vector< uint >, vector< Health >> &travellers)=0
 
virtual void hostForeignTravellers (const vector< stride::Simulator::TravellerType > &travellers, uint days, const string &destination_district, const string &destination_facility)=0
 Receive travellers travellers: the travellers this simulator has to host. More...
 
virtual void sendNewTravellers (uint amount, uint days, const string &destination_sim_id, const string &destination_district, const string &destination_facility)=0
 Commands to send an amount of travellers to another region The Simulator will have to take action, select travellers, and indicate which travellers he chose amount: the amount of travellers to be sent days: how long these people will be gone destination_sim: a way of communicating with the destination simulator, this must contain all data to achieve communication destination_district: The name of the city in which the airport / facility is located e.g. More...
 
virtual void returnForeignTravellers ()=0
 Return foreign people that would return today, signals the Simulator to return today's travellers. More...
 
virtual ~AsyncSimulator ()
 

Private Member Functions

virtual void sendNewTravellers (const vector< Simulator::TravellerType > &travellers, uint days, const string &destination_sim_id, const string &destination_district, const string &destination_facility)=0
 Send specifically chosen travellers to the destination region This function is used by the Simulator to give the signal to send people. More...
 
virtual void returnForeignTravellers (const pair< vector< uint >, vector< Health >> &travellers, const string &home_sim_id)=0
 Send foreign travellers to the original region This function is used by the Simulator to give the signal to send people. More...
 

Detailed Description

Definition at line 20 of file AsyncSimulator.h.

Constructor & Destructor Documentation

virtual stride::AsyncSimulator::~AsyncSimulator ( )
inlinevirtual

Definition at line 50 of file AsyncSimulator.h.

Member Function Documentation

virtual string stride::AsyncSimulator::getName ( ) const
pure virtual
virtual future<SimulatorStatus> stride::AsyncSimulator::timeStep ( )
pure virtual
virtual void stride::AsyncSimulator::welcomeHomeTravellers ( const pair< vector< uint >, vector< Health >> &  travellers)
pure virtual
virtual void stride::AsyncSimulator::hostForeignTravellers ( const vector< stride::Simulator::TravellerType > &  travellers,
uint  days,
const string &  destination_district,
const string &  destination_facility 
)
pure virtual

Receive travellers travellers: the travellers this simulator has to host.

Contains the data needed to identify a person in the home simulator days: The amount of days the travellers will stay in this simulator destination_district: The name of the city in which the airport / facility is located e.g. "Antwerp" destination_facility: The name of the facility / airport e.g. "ANR"

Implemented in stride::RemoteSimulatorSender, and stride::LocalSimulatorAdapter.

virtual void stride::AsyncSimulator::sendNewTravellers ( uint  amount,
uint  days,
const string &  destination_sim_id,
const string &  destination_district,
const string &  destination_facility 
)
pure virtual

Commands to send an amount of travellers to another region The Simulator will have to take action, select travellers, and indicate which travellers he chose amount: the amount of travellers to be sent days: how long these people will be gone destination_sim: a way of communicating with the destination simulator, this must contain all data to achieve communication destination_district: The name of the city in which the airport / facility is located e.g.

"Antwerp" destination_facility: The name of the facility / airport e.g. "ANR"

Implemented in stride::RemoteSimulatorSender, and stride::LocalSimulatorAdapter.

virtual void stride::AsyncSimulator::returnForeignTravellers ( )
pure virtual

Return foreign people that would return today, signals the Simulator to return today's travellers.

Implemented in stride::RemoteSimulatorSender, and stride::LocalSimulatorAdapter.

virtual void stride::AsyncSimulator::sendNewTravellers ( const vector< Simulator::TravellerType > &  travellers,
uint  days,
const string &  destination_sim_id,
const string &  destination_district,
const string &  destination_facility 
)
privatepure virtual

Send specifically chosen travellers to the destination region This function is used by the Simulator to give the signal to send people.

Implemented in stride::RemoteSimulatorSender, and stride::LocalSimulatorAdapter.

virtual void stride::AsyncSimulator::returnForeignTravellers ( const pair< vector< uint >, vector< Health >> &  travellers,
const string &  home_sim_id 
)
privatepure virtual

Send foreign travellers to the original region This function is used by the Simulator to give the signal to send people.

Implemented in stride::RemoteSimulatorSender, and stride::LocalSimulatorAdapter.


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