Assignment Overview
You are tasked with creating a text-based program for simulating a
Recycling Machine
using the Python 3 programming language.
The assignment is broken up into four main components:
1.) Design and model two classes:
RecyclableItem
and
RecyclingMachine,
2.) Create an
activity chart
which describes the behaviour of the Recycling Machine system,
3.) Create a
computer program
that allows a user to enter items that are able to be recycled into a machine. During the process the machine prompts the user for the type of item to be recycled and how many they have to enter. The machine keeps track of the number of each of the different items and keeps track of the total amount to pay the user until they indicate that they are finished. When they stop adding items, print out a receipt and given them the amount of money owing. The receipt should contain the following:
a. A list showing how many of each item has deposited and the cost of each item.
b. The total amount provided for each item
c. The total money received.
4.) Finally, explain and integrate some code into your Recycling Machine program that keeps track of how many items of each type are in the machine, and, if the machine is full, makes deposits of that item type unavailable. You machine should have at least 4 different products, and allow up to 50 of each product.
Your submission should consist of one document containing the first two parts of the assignment, and three Python scripts that implement the computer program (recyclingmachine.py, recyclableItem.py
and
main.py).
The
main.py
script runs the main logic of the program and will use instances of the
RecyclingMachine
and
RecyclableItem
classes to simulate depositing into a Recycling Machine.
You are provided with a Microsoft Word template to help you complete the first two parts of this assignment.
Towards the end of this document you will also be provided with the output of a simulated run of the completed computer program which may help you with this assignment.
Assignment Part 1 Details – Class Design
Think of a product that you can recycle that you might want to be able to deposit into a Recycling Machine, like maybe an empty soft drink can.
Start by listing all the properties of that object that you can think of – try to come up with at least
ten
general properties of a
RecyclableItem
and write these down in your
Assignment_Part_1_
Microsoft Word document, provided for download in the assessment section of your Moodle shell.
Next, use the process of
abstraction
to cut the number of properties back to only ‘key’ properties – write these down in the next section of your Word document. Take a look at the week 2 lecture slides if you need a reminder on how to go about this.
Now, fill in the class diagram for your Item class in the Word document template provided. Your
RecyclableItem
class does not have to have any methods (i.e. functions) associated with it to perform any actions other than a
constructor
which takes and set the key properties that you’ve identified.
Next we’ll move on to
RecyclingMachine
class – think about what information the Recycling Machine has to keep track of to allow you to successfully deposit an item to be recycled. There will only really be three key properties that the RecyclingMachine cares about, and the RecyclingMachine class should have the following five methods available:
1) A
default constructor
that takes no arguments and initialises a new object and its properties,
2)
accept_product(),
3)
select_product()
4)
payout(anAmount)
5)
print_receipt().
Fill in the class diagram for the
RecyclingMachine
class in the Word template, and that’s the first part completed!
Assignment Part 2 Details – Activity Flowchart
Using either the online website
https://draw.io
(preferred), or the applications Visio or Powerpoint – create an activity diagram of how the program should operate to successfully enter their money, buy one or more products, provide change and print a receipt for the user.
Make sure to use the
correct symbols
in your diagram for starting, processes, decisions/branches, and ending the process.
Although you may be familiar with how a Recycling Machine works, if not then you can always look online Recycling Machine.
Don’t worry about taking payment to debit or credit cards, our RecyclingMachine will only provide cash.
Once you have completed your activity chart, add it to your assignment template document.
Assignment Part 3 Details – Software Implementation
You are free to implement the software however you see fit, however the
functionality
of the software should be able to match the following output. Note that in the below run of the program I have ‘hard-coded’ a small number of
RecyclableItem
instances so that products which exist can be purchased – in your code you should do the same.
Your program does not have to have the facility to add new recyclable items – just define a few and use them as demonstrated below. If the final option of
STOP
is chosen, the program should print the receipt and ask the user if they want to start again or quit.
Assignment Overview
You are tasked with creating a text-based program for simulating a
Recycling Machine
using the Python 3 programming language.
The assignment is broken up into four main components:
1.) Design and model two classes:
RecyclableItem
and
RecyclingMachine,
2.) Create an
activity chart
which describes the behaviour of the Recycling Machine system,
3.) Create a
computer program
that allows a user to enter items that are able to be recycled into a machine. During the process the machine prompts the user for the type of item to be recycled and how many they have to enter. The machine keeps track of the number of each of the different items and keeps track of the total amount to pay the user until they indicate that they are finished. When they stop adding items, print out a receipt and given them the amount of money owing. The receipt should contain the following:
a. A list showing how many of each item has deposited and the cost of each item.
b. The total amount provided for each item
c. The total money received.
4.) Finally, explain and integrate some code into your Recycling Machine program that keeps track of how many items of each type are in the machine, and, if the machine is full, makes deposits of that item type unavailable. You machine should have at least 4 different products, and allow up to 50 of each product.
Your submission should consist of one document containing the first two parts of the assignment, and three Python scripts that implement the computer program (recyclingmachine.py, recyclableItem.py
and
main.py).
The
main.py
script runs the main logic of the program and will use instances of the
RecyclingMachine
and
RecyclableItem
classes to simulate depositing into a Recycling Machine.
You are provided with a Microsoft Word template to help you complete the first two parts of this assignment.
Towards the end of this document you will also be provided with the output of a simulated run of the completed computer program which may help you with this assignment.
Assignment Part 1 Details – Class Design
Think of a product that you can recycle that you might want to be able to deposit into a Recycling Machine, like maybe an empty soft drink can.
Start by listing all the properties of that object that you can think of – try to come up with at least
ten
general properties of a
RecyclableItem
and write these down in your
Assignment_Part_1_
Microsoft Word document, provided for download in the assessment section of your Moodle shell.
Next, use the process of
abstraction
to cut the number of properties back to only ‘key’ properties – write these down in the next section of your Word document. Take a look at the week 2 lecture slides if you need a reminder on how to go about this.
Now, fill in the class diagram for your Item class in the Word document template provided. Your
RecyclableItem
class does not have to have any methods (i.e. functions) associated with it to perform any actions other than a
constructor
which takes and set the key properties that you’ve identified.
Next we’ll move on to
RecyclingMachine
class – think about what information the Recycling Machine has to keep track of to allow you to successfully deposit an item to be recycled. There will only really be three key properties that the RecyclingMachine cares about, and the RecyclingMachine class should have the following five methods available:
1) A
default constructor
that takes no arguments and initialises a new object and its properties,
2)
accept_product(),
3)
select_product()
4)
payout(anAmount)
5)
print_receipt().
Fill in the class diagram for the
RecyclingMachine
class in the Word template, and that’s the first part completed!
Assignment Part 2 Details – Activity Flowchart
Using either the online website
https://draw.io
(preferred), or the applications Visio or Powerpoint – create an activity diagram of how the program should operate to successfully enter their money, buy one or more products, provide change and print a receipt for the user.
Make sure to use the
correct symbols
in your diagram for starting, processes, decisions/branches, and ending the process.
Although you may be familiar with how a Recycling Machine works, if not then you can always look online Recycling Machine.
Don’t worry about taking payment to debit or credit cards, our RecyclingMachine will only provide cash.
Once you have completed your activity chart, add it to your assignment template document.
Assignment Part 3 Details – Software Implementation
You are free to implement the software however you see fit, however the
functionality
of the software should be able to match the following output. Note that in the below run of the program I have ‘hard-coded’ a small number of
RecyclableItem
instances so that products which exist can be purchased – in your code you should do the same.
Your program does not have to have the facility to add new recyclable items – just define a few and use them as demonstrated below. If the final option of
STOP
is chosen, the program should print the receipt and ask the user if they want to start again or quit.
Assignment Part 1 Details – Class Design
Insert your list/table of possible RecycleableItem
properties here…
RecycleableItem Properties (All)
Insert your list/table of key product properties here…
RecycleableItem Properties (Key)
Complete the class diagram of your final RecycleableItem class here…
RecycleableItem Class Diagram
RecyclingMachine Class Diagram
Complete the class diagram of your final Recycling class here…
Assignment Part 2 – Activity Flowchart
Insert your activity flowchart of the recycling machine process here… If your flowchart is large then place it on the following page.
Assignment Part 3 – Software Implementation
Do not place your code here – provide the code as separate .py files submitted with this document.
Assignment Part 4 – Code Explanation and Use
Update the below code to insert comments describing what the code is doing – for each line starting with a hash symbol (#) you should write your code comments after the hash. You may add a second line of comments if you require more space.
# Function to: ___________________________
def
get_int(prompt):
# ____________________________________
value
=
int(0)
# ____________________________________
while
True
:
try
:
# ____________________________________
value
=
int(input(prompt))
# ____________________________________
if
value
0:
print
("We don't accept a negative number of items!")
continue
# ____________________________________
break
# ____________________________________
except
ValueError:
print
('Please enter a valid integer value.')
# ____________________________________
return
value
# Function to: ___________________________
def
accept_item(item_list):
# ____________________________________
item_list
=
[]
non_accepted_items
=
[]
MAX_WEIGHT
=
15.0
# ____________________________________
for
item
in
item_list:
# ____________________________________
if
item.weight
>
MAX_BAG_WEIGHT:
item_list.remove(item)
non_accepted_items.append(item)
# ____________________________________
current_contents
=
[]
current_weight
=
0.0
# ____________________________________
while
len(item_list)
>
0:
# ____________________________________
temp_item
=
item _list[0]
item_list.remove(temp_item)
# ____________________________________
if
current_weight
+
temp_item.weight
MAX_WEIGHT:
# ____________________________________
current_contents.append(temp_item)
current_weight
+=
temp_item.weight
# ____________________________________
if
(len(item_list)
==
0):
products_item.append(current_contents)
# ____________________________________
else
:
item_list.append(current_contents)
# ____________________________________
current_contents
=
[]
current_weight
=
0.0
# ____________________________________
for
index,
bag
in
enumerate(machine_list):
output
=
'Machine '
+
str(index
+
1)
+
' contains: '
# ____________________________________
for
item
in
items:
output
+=
item.name
+
'\t'
print
(output,
'\n')
# ____________________________________
if
(len(non_accepted_items)
>
0):
output
=
'Non-bagged items: '
# ____________________________________
for
item
in
non_accepted_items:
output
+=
item
+
'\t'
print
(output,'\n')