pythagora.groups.CommunitySet

class documentation

class CommunitySet:

Constructor: CommunitySet(list_of_communities, assemblage)

View In Hierarchy

A CommunitySet is a group of communities.

Method __init__ Instantiates a CommunitySet.
Method __str__ Undocumented
Method add_buyer_to_community_by_index Adds a specific buyer to a specific community using a community index.
Method add_buyer_to_community_by_name Adds a specific buyer to a specific community using their name variables.
Method add_community Add a community to the group.
Method get_all_buyers_in_community_set Returns a list of all buyers in all communities in this CommunitySet.
Method more_than_min_communities Checks if the number of communities is above a certain threshold.
Method number_of_communities Returns the number of communities.
Property assemblage List of pots available in market.
Property list_of_communities List of all communities in this group
Instance Variable _assemblage Undocumented
Instance Variable _list_of_communities Undocumented
def __init__(self, list_of_communities, assemblage):

Instantiates a CommunitySet.

Parameters
list_of_communitiescommunities to add to group
assemblageitems for sale in this market
def __str__(self):

Undocumented

def add_buyer_to_community_by_index(self, buyer, index):

Adds a specific buyer to a specific community using a community index.

Parameters
buyername of target buyer
indexindex of community to which to add buyer
def add_buyer_to_community_by_name(self, buyer, community):

Adds a specific buyer to a specific community using their name variables.

Parameters
buyername of target buyer
communityname of community to which to add buyer
def add_community(self, new_community):

Add a community to the group.

Parameters
new_communitycommunity to add
def get_all_buyers_in_community_set(self):

Returns a list of all buyers in all communities in this CommunitySet.

Returns
a list of all buyers in all communities in this CommunitySet
def more_than_min_communities(self, min_number):

Checks if the number of communities is above a certain threshold.

Parameters
min_numberminimum number of communities
Returns
True if number of communities is at least min_number; False otherwise
def number_of_communities(self):

Returns the number of communities.

Returns
the number of communities.
@property
assemblage =

List of pots available in market.

@property
list_of_communities =

List of all communities in this group

_assemblage =

Undocumented

_list_of_communities =

Undocumented