Stride Reference Manual  1.0
stride::District Class Reference

A district is either a city or a village (currently, there is no difference between city and village) More...

#include <District.h>

Collaboration diagram for stride::District:
Collaboration graph

Public Member Functions

 District (string district_name, uint influence_size, double influence_speed, double influence_minimum, GeoCoordinate location=GeoCoordinate(0, 0))
 Constructor. More...
 
void addFacility (string facility_name)
 Add a transportation facility to this district. More...
 
bool hasFacility (string facility_name) const
 If the facility is found in this district, return true. More...
 
double getFacilityInfluence (string facility_name) const
 
void visitFacility (string facility_name, uint amount)
 
void advanceInfluencesRecords ()
 
bool operator== (const District &other_district)
 Equals operator for districts, two districts are equal if their name is the same. More...
 
string getName () const
 Return the name of the district. More...
 
GeoCoordinate getLocation () const
 

Private Member Functions

vector< pair< string, Influence > >::const_iterator getFacility (string facility_name) const
 
vector< pair< string, Influence > >::iterator getFacility (string facility_name)
 

Private Attributes

vector< pair< string, Influence > > m_transportations_facilities
 The transportation facilities have a name (string) and a sphere of influence. More...
 
string m_name
 The name of the city/village. More...
 
const GeoCoordinate m_location
 The geographic location of the district. More...
 
const uint m_influence_size
 All Influences of facilities will get this size. More...
 
const uint m_influence_speed
 All Influences of facilities will get this speed. More...
 
const uint m_influence_minimum
 All Influences of facilities will get this minimum. More...
 

Friends

class ClusterSaver
 

Detailed Description

A district is either a city or a village (currently, there is no difference between city and village)

Definition at line 26 of file District.h.

Constructor & Destructor Documentation

stride::District::District ( string  district_name,
uint  influence_size,
double  influence_speed,
double  influence_minimum,
GeoCoordinate  location = GeoCoordinate(0, 0) 
)
inline

Constructor.

Definition at line 29 of file District.h.

Member Function Documentation

void stride::District::addFacility ( string  facility_name)
inline

Add a transportation facility to this district.

Definition at line 38 of file District.h.

bool stride::District::hasFacility ( string  facility_name) const
inline

If the facility is found in this district, return true.

Definition at line 46 of file District.h.

double stride::District::getFacilityInfluence ( string  facility_name) const
inline

Definition at line 50 of file District.h.

void stride::District::visitFacility ( string  facility_name,
uint  amount 
)
inline

Definition at line 59 of file District.h.

void stride::District::advanceInfluencesRecords ( )
inline

Definition at line 66 of file District.h.

bool stride::District::operator== ( const District other_district)
inline

Equals operator for districts, two districts are equal if their name is the same.

Definition at line 73 of file District.h.

References m_name.

string stride::District::getName ( ) const
inline

Return the name of the district.

Definition at line 76 of file District.h.

GeoCoordinate stride::District::getLocation ( ) const
inline

Definition at line 78 of file District.h.

vector<pair<string, Influence> >::const_iterator stride::District::getFacility ( string  facility_name) const
inlineprivate

Definition at line 88 of file District.h.

vector<pair<string, Influence> >::iterator stride::District::getFacility ( string  facility_name)
inlineprivate

Definition at line 93 of file District.h.

Friends And Related Function Documentation

friend class ClusterSaver
friend

Definition at line 98 of file District.h.

Member Data Documentation

vector<pair<string, Influence> > stride::District::m_transportations_facilities
private

The transportation facilities have a name (string) and a sphere of influence.

Definition at line 81 of file District.h.

string stride::District::m_name
private

The name of the city/village.

Definition at line 82 of file District.h.

Referenced by operator==().

const GeoCoordinate stride::District::m_location
private

The geographic location of the district.

Definition at line 83 of file District.h.

const uint stride::District::m_influence_size
private

All Influences of facilities will get this size.

Definition at line 84 of file District.h.

const uint stride::District::m_influence_speed
private

All Influences of facilities will get this speed.

Definition at line 85 of file District.h.

const uint stride::District::m_influence_minimum
private

All Influences of facilities will get this minimum.

Definition at line 86 of file District.h.


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