Assignment 1
Learning Outcomes & Materials
This assignment is intended to develop and assess the following unit learning outcomes:
LO1. Iteratively apply object-oriented design principles to design small to medium-size software systems, using
standard software engineering notations, namely UML class diagrams and UML interaction diagrams.
LO2. Describe the quality of object-oriented software designs, both in terms of meeting user requirements and
the effective application of object-oriented design concepts and principles.
LO3. Apply object-oriented programming constructs, such as abstraction, information hiding, inheritance, and
polymorphism, to implement object-oriented designs using a programming language (namely, Java).
LO5. Apply principles of software engineering practice to create object-oriented systems with peers using tools
including integrated development environments (IDEs), UML drawing tools, and version control systems.
To demonstrate your ability, you will be expected to:
read and understand UML design documentation for an existing Java system
propose a design for additional functionality for this system
create UML class diagrams to document your design using a UML drawing tool such as
diagrams.net, UMLet or plantuml – you are free to choose which one
write a design rationale evaluating your proposed design and outlining some alternatives
implement the features of the system that you designed
use an integrated development environment to do so
use git to manage your team's files and documents
The marking scheme for this assignment will reflect these expectations
Learning Materials
The base code will be automatically available in your group's repository (Gitlab).
Repeat this mantra: Design, write code, test, fix design, fix code, repeat
Note: You must NOT follow demo apps' design decisions; they only show how to use the engine, NOT how to
design a proper system with object-oriented principles.Introduction
For the rest of the semester, you will be working on a relatively large software project. You will design
and implement new functionalities to an existing system that we will provide to you.
IMPORTANT: A document explaining the FIT2099 Assignment Rules (a module above Assignment 1). Please
read it and make sure you understand BEFORE you begin the project for your own benefits (i.e., get good
grades and better learning experience).
In this assignment (Assignment 1), you will be working individually to implement the first few
features of the game. We highly recommend starting by extracting all of the game features. Then,
proceed with designing, testing, and repeating the process as needed. This iterative design-thinking
approach will help ensure a well-developed and refined system.
Getting Started
The initial codebase will be available in a repository that will be created for you on
git.infotech.monash.edu. In the meantime, please go through the assignment support modules on Ed
Lesson to familiarise yourself with the game engine that you will use during the assignment.
You do not need to submit an interaction diagram (e.g. sequence diagram or communication diagram) in
assignment 1. However, you will need to submit these documents for Assignment 2 and Assignment 3. For
assignment 1, you may still create these documents if you find them useful for designing the system.
General background
You will be working on a text-based “rogue-like” game. Rogue-like games are named after the first
such program: a fantasy game named Rogue. They were very popular in the days before home
computers were capable of elaborate graphics and still have a small but dedicated following.
If you would like more information about rogue-like games, a good site is http://www.roguebasin.com/. The
initial codebase will be available in the repository mentioned above. It includes a folder containing design
documents for the system. ELDEN THING: SHADOW OF THE INHERITREE
In this assignment, we will develop the “ELDEN THING: SHADOW OF THE INHERITREE” game, inspired
by the recently released downloadable content for the game Elden Ring: "ELDEN RING Shadow of the
Erdtree". We may use several similar names (characters, items, locations) and concepts. The purpose
of using an actual game’s concepts is to help you visualise the required features, such as watching the
video gameplay from the actual game to illustrate features that you may find challenging to
comprehend. We also believe using actual game references may bring fun while working on the
assignments.
All linked game contents, videos, and images belong to the respective owners and are
subject to copyright. We mainly use the concepts for educational purposes and provide
credit to the original creators accordingly. We may also add, alter, and reduce the
original content and features to make them more suitable to the game engine, unit
outcomes, and assignments’ time frame.
What’s next?
Below are four slides (REQ1-REQ4) describing the requirements you need to complete. Each
requirement includes game features that include background stories, entity descriptions (actors,
items, or ground), relationships between entities, and actions between them. We suggest extracting
these features into a list and discussing it with the TAs to ensure all features are included (this
discussion is not assessed, but highly recommended).
Following these requirement slides, we will outline the deliverables necessary for the Assignment 1
assessment.Meet Alexander, the Pot Friend
Expand
Alexander, the Pot Friend
Image: Alexander, Warrior Jar (source: https://eldenring.fandom.com/wiki/Alexander,_Warrior_Jar)
Throughout your learning journey, "Alexander, the Pot Friend" will give you advice throughout the
assignment specifications that you may need to take note of inside "info" boxes. For example:
Alexander says, "Prithee, peruse the assignment specifications with care ere thou dost commence."
Please read the assignment specifications thoroughly before you start. We recommend that you visit (or revisit)
the Assignment Support modules in Weeks 2-5.
Disclaimer:
In the spirit of the original game, we have enlisted the help of ChatGPT 4.0 (Microsoft Copilot) to
generate all Old English quotes within these assignment specifications. It always starts with a wise
quote from Alexander, the Pot Friend, followed by the actual information/hint/warning that you
need to care about. We hope this adds a slight element of fun and whimsy as you read through
the requirements. Enjoy the journey back in time!
Here are some example prompts we have used:
“Generate an Old-English quote about the XXX.”
“Create an Old-English phrase about 'keep it simple, stupid'.”
“Provide an Old-English proverb related to 'be careful of giant's attack'.”REQ1: The Lord of the Old Order
Image: The Tarnished (source:
https://static.wikia.nocookie.net/eldenring/images/5/52/Tarnished_E3_2021.jpg/revision/latest/scale-towidth-down/1000?cb=20210621011318)
In
Elden Thing, you play as the “Tarnished” ( @ ), who has claimed the Elden Throne, becoming the
Lord of the Old Order.
Now, following the trail of a seemingly missing demigod, the Tarnished enters the Land of Shadow
(see REQ2 Title), where the event of the game takes place.
The “Tarnished” starts at a map called the “Gravesite Plain” inside a small shack (see info box below).
"..........~~~~~~~...~~~~~~~......~...........",
"~..........~~~~~....~~~~~~...................",
"~~.........~~~~.....~~~~~~...................",
"~~~..#####..~~.....~~~~~~~...................",
"~~~..#___#........~~~~~~~~~..................",
"~~~..#___#.......~~~~~~.~~~..................",
"~~~..##_##......~~~~~~.......................",
"~~~~...........~~~~~~~...........~~..........",
"~~~~~.........~~~~~~~~.......~~~~~~~.........",
"~~~~~~.......~~~~~~~~~~.....~~~~~~~~........."
The "Gravesite Plain" map
The small shack is represented by several squares of floor ( _ ) and surrounded by walls ( # ).
```
#####
#____#
#____#
##_##
```They start with 150 hit points (health), 100 mana, and 5 strength.
Alexander says, "Verily, ensure thou dost ever display the Tarnished’s vitalities"
Make sure to always display the Tarnished’s attributes (hitpoints, mana, and strength) at each game tick.
Within the surroundings of the shack, there are two weapons that the Tarnished can pick up: A Short
Sword ( ! ) and Great Knife ( † ).
The Tarnished must have at least 10 strength points to pick up the Short Sword and at least 5 strength
points to pick up the Great Knife. Once picked up, they can use the Short Sword to attack enemies (see
REQ4), dealing 100 damage with a 75% chance to hit (hit rate). The Great Knife can also be used to
attack enemies, dealing 75 damage with a 60% chance to hit. The Tarnished may also decide to drop
any of the picked-up weapons at any time and pick any of them up again.
The Tarnished may also decide to attack enemies with their bare fist, dealing 25 damage with a 50%
chance to hit.
Alexander says, "Gather thou the weapons thy heart desires, for in thy hands lies the power to wield them all.”
The Tarnished can pick up as many weapons as they want. If there are multiple weapons in their inventory, the
Tarnished can choose to attack with each weapon, in addition to the bare fist.REQ2: The Land of Shadow
Image. The Land of Shadow (source:
https://static.wikia.nocookie.net/eldenring/images/5/52/ER_The_Land_of_Shadows.jpeg/revision/latest/scal
e-to-width-down/1000?cb=20240221154538)
Inside the small shack, the Tarnished can pick up two items: Flask of Healing ( u ) and Flask of
Rejuvenation ( o ). Both items can be consumed by the Tarnished. Similar to the weapons in REQ1,
both items can be dropped off at any time.
Upon use, Flask of Healing heals the Tarnished by 150 hit points. This flask has 5 charges, i.e., it can be
consumed by the Tarnished 5 times.
Flask of Rejuvenation restores the Tarnished’s mana by 100 points when used. Unlike the Flask of
Healing, this flask only has 3 charges.
Once a flask (Flask of Healing or Flask of Rejuvenation) runs out of charges, it will not vanish from the
world, i.e., the Tarnished can still choose to consume the empty flask, but attempting to consume an
empty flask will result in a message, such as Flask of Healing is empty or Flask of
Rejuvenation is empty , to be displayed on the screen.
Heading out to explore the Land of Shadow, the Tarnished finds several Shadowtree Fragments ( e )
scattered around, which can be picked up and dropped off at any time. Consuming one Shadowtree
Fragment blesses the Tarnished, increasing their maximum hit points by 50 points, their maximum
mana by 25 points, and their maximum strength points by 5 points.
Alexander says, "Pray thee, kind soul, lend thine aid in this endeavour, for together we shall achieve greatness."
You must manually put 5 instances of the Shadowtree Fragment on the first game map.
Unlike the Flask of Healing and Flask of Rejuvenation, once consumed, the Shadowtree Fragment will disappear from the Tarnished’s inventory, i.e., it can only be consumed once.
Here are some design considerations when working on this requirement (Note that this list is non-exhaustive):
- In the future version of the game, there could be other “things” that the Tarnished can consume.
- A “thing” may not always be an item.
- Once consumed, these “things” may produce different effects, such as poisoning the player, healing the
player over time, etc.
Can your design accomodate this potential extension while adhering to the principles taught in the unit, e.g.,
the SOLID principles?REQ3: The Furnace Golem
Expand
Image. The Furnace Golem (source:
https://static.wikia.nocookie.net/eldenring/images/0/08/Shadow_of_the_Erdtree_promotional_screenshot_2
.jpg/revision/latest/scale-to-width-down/1000?cb=20240221190058)
The Furnace Golems ( A ) are foes that the Tarnished must face in the Land of Shadow. They are large
titans with flames set eternally ablaze in their basket-like torso.
A Furnace Golem has 1000 hit points. It can wander around the game map.
If the Tarnished is within its surroundings (adjacent squares), the golem will stop wandering around,
but instead, it will stomp the Tarnished with its foot, dealing 100 damage with a 5% chance to hit.
Alexander says, “An enemy’s blade may not seek their own ally, yet in the clash of arms, unintended harm may befall.”
An enemy cannot directly target and attack another enemy. An enemy's attack may result in a collateral
damage to another enemy.
Alexander says, "Pray thee, kind soul, the heavens proclaim thy name should thee meet thy end, for it is a reminder of our
mortal trials."
Make sure to print out the "YOU DIED" message when the Tarnished dies.
Once within its surroundings, the Furnace Golem will follow the Tarnished around the map until either
one of them dies.
Alexander says, "Venture forth upon the path to the Red Planet, and grand rewards shall be thine!"
It also cannot enter the floor ( _ ), allowing the Tarnished to escape safely to the small shack if needed.Here are some design considerations when working on this requirement (Note that this list is non-exhaustive)
- There may be other NPCs (non-playable characters) in the future version of the game, which may or may not
be hostile towards the Tarnished.
- Other NPCs may be able to wander around and attack the Tarnished if they are hostile. They may have other
ways of behaving, e.g., following the Tarnished around, picking up items, etc.
- There's a possibility to have more behaviours in the future, and these behaviours must be 'ordered' to
simulate a "rule-based Artificial Intelligence".
Can your design accomodate this potential extension while adhering to the principles taught in the unit, e.g.,
the SOLID principles?REQ4: "O Tarnished of no renown, you shall burn"
Expand
Image. The Furnace Golem's stomp attack, resulting in a large explosion within its surroundings area
(source: https://eldenring.wiki.fextralife.com/file/Elden-Ring/furnace-golem-elden-ring-wiki.jpg)
Due to its size, a Furnace Golem stomp has a 10% chance to create an explosion regardless of whether
the stomp attack hits the Tarnished, dealing 50 collateral damage to all actors (friends or foes) within
the golem's surroundings. This means that there is a possibility for the Golem to deal damage twice
to the tarnished: one with its stomp attack and the other one with the explosion.
Alexander again says, “An enemy’s blade may not seek their own ally, yet in the clash of arms, unintended harm may
befall.”
An enemy cannot directly target and attack another enemy. An enemy's attack may result in a collateral
damage to another enemy.
Alexander says, "Beware the giant’s onslaught, for their might is great and their wrath fierce."
Make sure to print out a message when the Furnace Golem deals the explosion damage, e.g., Furnace
Golem's stomp attack results in shockwave in the surrounding areas.
Additionally, the explosion results in the surrounding area of the Furnace Golem being burned. The
fire ( w ) lasts for 5 turns. If the tarnished stands within the burning ground, they will take 5 damage
per turn. The Furnace Golem itself is resistant to fire, i.e., stepping into the burning ground will not
inflict damage upon it. Puddles ( ~ ), however, cannot be burned, allowing the Tarnished to stay safe
from the burn damage, i.e., Other grounds, including Dirt, Wall, and Floor can be burned. Once the
burning ends, the ground will return to its original form.
Depending on your implementation, the fire damage may stack if the Furnace Golem burns the
same locations over and over again.Here are some design considerations when working on this requirement (Note that this list is non-exhaustive)
- Other NPCs' attack may result in a different effect, e.g. Furnace Golem's attack can cause a shockwave,
damaging all actors within its surroundings.
- There may be other types of grounds that are not burnable.
- Other NPCs' may be resistant to burning
Can your design accomodate this potential extension while adhering to the principles taught in the unit, e.g.,
the SOLID principles?Submission Instructions
Not following any one of the instructions below will result in penalty being applied to your final submission.
You do not need to submit an interaction diagram (e.g. sequence diagram or communication diagram) in
assignment 1. However, you will need to submit these documents for assignment 2 and assignment 3. For
assignment 1, you may still create these documents if you find them useful for designing the system although
we cover them in later weeks.
We will mark your assignment based on the latest commit in the main branch in your GitLab repository by the
due date, not in the master branch.
Class Diagrams & Documentation Submission
As mentioned in the Design & Diagrams section, you MUST create one design (class)
diagram per requirement. In other words, each requirement must be represented in its own
separate diagram. Organising them in one large design diagram or combining requirements
based on their packages is not allowed. Doing so may reduce the clarity of your design diagram
or could be seen as an attempt at reverse engineering. Penalties will be applied if this occurs.
Please keep each requirement diagram distinct and avoid any attempts to merge or combine
them.
You MUST save your design documentation, including design diagrams, rationale and report
(diagram + rationale combined into a single document), in the
"docs/design/{assignmentName}" directory. So, for Assignment 1, you must save all design
documentation in the "docs/design/assignment1" directory.
TAs cannot be expected to look at other directories, except for "docs/design/{assignmentName}", when
marking the design diagrams and rationale.
All design documentation must be saved in PDF format (or PNG/PDF for diagrams, such as
REQ1.png, REQ2.png, and so on).
A Moodle submission is compulsory, and it must be done before the deadline. Please,
compress ALL files (code, documentation, and diagrams) as one zip file, and submit the
compressed file.
Disclaimer: Although there are multiple ways to design the game, there are also bad designs and good designs
- we will mark your submission not against one design but based on the design principles
Design DiagramsWe expect you to produce four UML class diagrams following the FIT2099 Assignment Rules. These
Rules are available on EdLesson.
You should not create one class diagram that shows the entire system. The sample diagram in
the base code shows the whole system to help you understand how the game works with the
engine . But, in this assignment, you only need to show the following:
the new parts,
the parts you expect to change, and
enough information to let readers know where your new classes fit into the existing system.
As it is likely that the precise names and signatures of methods will be refactored during
development, you do not have to put them in these class diagrams. Instead, the overall
responsibilities of the classes need to be documented somewhere, as you will need this information to
begin implementation. This can be done in a separate text document ( .md markdown format) or
spreadsheet, which you should put inside the docs directory. We will not assess this document, but
we believe it will be handy during the implementation phase.
Design Rationale
A design rationale should be created for each requirement, with a maximum word limit of 1,000 words per
requirement. However, aim for concise and focused explanations (at least ~500 words). You can submit a single
text-based/PDF document.
To help us understand how your system will work, you must also write a design rationale to explain
your choices. You must demonstrate how your proposed system will work and why you chose to do
it that way. Here is where you should write down concepts and theories you've learnt so far (e.g.,
DRY, coupling and cohesion, etc.). You must consider the pros and cons of the design to justify your
argument.
The design (which includes all the diagrams and text that you create) must clearly show the following:
what classes will exist in your extended system
what the roles and responsibilities of any new or significantly modified classes are
how these classes relate to and interact with the existing system
how the (existing and new) classes will interact to deliver the required functionality
You are not required to create new documentation for components of the existing system that you do
not plan to change.
IMPORTANT! We will not accept any Word document because it cannot be opened/displayed in Gitlab.
ImplementationWe will assess your design implementation (i.e., Java codes). We will assess all of your codes in the
Gitlab repository. Please ensure you push/merge all of your local Java codes to the main branch.
You need to ensure that your game can run without breaking. Please follow the "Testing Instructions"
from each requirement to satisfy the completeness of its features.
A reminder: you must not modify the game engine, as stated in the assignment rules document.
Your implementation must adhere to the Google Java coding standards.
Google Java coding standards: https://google.github.io/styleguide/javaguide.html#s5-naming
Write Javadoc comments for at least all public and protected methods and attributes in your classes.
You will be marked on your adherence to the standards, Javadoc, and general commenting guidelines
that were posted to EdStem earlier in the semester.
To ensure that your work adheres to good coding practices in this unit, we encourage you to minimise the use
of instanceof and/or downcasting, as they are considered code smells. It's important to note that if there are
any instances where you need to use them, please provide appropriate justifications in code comments or
design rationale. We believe learning how to properly utilise polymorphism is crucial in addressing this code
smell, and we are committed to teaching you how to do so effectively.Marking Rubric
Assignment 1 rubric
Prerequisite for marking: Design documents (UML diagrams and design rationale) and
implementation need to be submitted for the assignment to go through the marking process. Missing
any of these will result in 0 marks.
Overview:
Total: 28 points
Feature implementation completeness (6 points)
Implementation quality: design principles (8 points)
Design rationale (4 marks)
Integration with the existing system (2 points)
UML syntax and clarity (2 points)
Alignment and design consistency (2 points)
Style & Javadoc (1 point)
Git usage (2 points)
Format and directory structure (1 point)
Detailed rubric items:
Feature implementation completeness (6 points)
6 marks - The system runs and perfectly meets all functional expectations as per the relevant
requirement(s) with no runtime errors. All required classes and relationships are implemented, and
the program's behaviour aligns perfectly with the specification.
5 marks - The system runs and meets all functional expectations (with some minor errors or
punctual omissions) as per the relevant requirement(s). All necessary classes and relationships are
included, and the program's behaviour largely matches the specification, except for one or two
minor unexpected behaviours. No runtime errors occur.
4 marks - The system runs and partially meets all functional expectations, displaying several
minor functional errors or omissions as per the relevant requirement(s). Despite this, the majority
of necessary classes and relationships are included, and only a few minor unexpected behaviours
occur. No runtime errors are present.3 marks - The system runs and all functional expectations were addressed to some extent,
(with one or two major functional errors) as per the relevant requirement(s). Most important classes
and relationships are included but at least one or two major unexpected behaviors are
observed. A major unexpected behaviour is that which affects considerably the completeness of at
least one requirement. No runtime errors occur.
2 marks - The system runs but several functional expectations were not addressed as per the
relevant requirement(s) (e.g. the notion of Behaviour is not included even though it is a part of the
requirement). Alternatively, runtime errors occur during the execution of the system but they can be
easily fixed.
1 mark - The system runs but addresses only some functional expectations and shows major
omissions as per the relevant requirement(s) (important classes or relationships are missing).
Alternatively, runtime errors occur during the execution of the system without a clear idea of the
cause or cannot be easily fixed.
0 marks - The system runs but it poorly addresses or doesn’t address the functional
expectations as per the relevant requirement(s). Alternatively, the system might not run at all.
Implementation quality: design principles (8 points)
This item applies across all functional expectations as per the relevant requirement(s)
8 marks - The implementation of all functional expectations as per the relevant requirement(s)
flawlessly adheres to good design principles and concepts (e.g., DRY and SOLID principles),
making the design easy to extend and maintain. Any punctual violations are convincingly justified in
the design rationale (e.g., using singleton to implement a feature). All relevant requirements have
been addressed.
7 marks - The implementation follows good design principles nearly perfectly making the design is
easy to extend and maintain (if some punctual principles are violated, the trade-off is somewhat
justified in the design rationale. All relevant requirements have been addressed.
6 marks - The implementation involves one or two minor violations of design principles (could
be easily fixed) across all functional expectations as per the relevant requirement(s) (e.g., some
attributes are not set to private without any justification). All relevant requirements have been
addressed.
5 marks - The implementation involves minor violations of design principles in multiple places
(could still be easily fixed) across all functional expectations as per the relevant requirement(s). All
relevant requirements have been addressed.
4 marks - The implementation involves one or two non-severe violations of design principles
that could be implemented in a better way (no trade-offs are convincingly provided in the
design rationale) across all functional expectations as per the relevant requirement(s) (e.g. some code repetitions are found in the implementation that would require some refactoring to be fixed). All
relevant requirements have been addressed.
3 marks - The implementation involves non-severe violations of design principles in multiple
places (no trade-offs are convincingly provided in the design rationale). All relevant requirements
have been addressed.
2 marks - The implementation involves one or two severe violations of design principles that could
be implemented in a better way across all functional expectations as per the relevant requirement(s),
e.g. violating the basic principles covered so far. Fixing them would require substantial refactoring.
Alternatively, not all relevant requirements have been attempted.
1 mark - The design/implementation can be considered hacky or various instances of procedural
programming are found. For example, the implementation uses downcasting and ‘instanceof’ in
various cases without a convincing justification. Alternatively, it can also be the case that abstraction
is not used, making the design difficult to extend and maintain. Alternatively, only some relevant
requirements have been attempted.
0 marks - The implementation mainly follows a non-OO paradigm; or the UML class diagram(s) or the
implementation is missing. Alternatively, most relevant requirements have not been attempted.
Design rationale (4 points)
4 marks - The design rationale includes a description of what has been done and why, focusing on
the principles and concepts taught in the unit (such as DRY and SOLID principles) and not in terms of
game design. The rationale discusses the advantages and disadvantages of the design (pros and
cons), the reasons for choosing the current design, and ways in which it can be easily extended
(e.g. my design achieves OCP because if a new character is added in the future ...). All relevant
requirements have been addressed.
3 marks - The rationale describes what has been done and why, based on the principles and
concepts taught in the unit. It also includes some discussion of the pros and cons of the design and
the reasons for the current design choice but lacks examples of future extensibility. All relevant
requirements have been addressed.
2 marks - The rationale describes what has been done and why, aligning with the principles and
concepts taught in the unit. However, it lacks a discussion on the pros and cons of the design
and/or examples of future extensibility. All relevant requirements have been addressed.
1 mark - The rationale primarily describes what has been done without a thorough explanation
of the decision-making reasons. For instance, it may mention design principles ad concepts without
providing convincing explanations, discussion of pros and cons, or examples of how the system can
be extended. Alternatively, not all relevant requirements have been attempted.
0 marks - The design rationale is either very challenging to read, is missing, or the submitted work omits more than one relevant requirement.
Integration with the existing system (2 points)
This item applies across all relevant requirements.
2 marks - The implementation effectively uses the engine classes (e.g. the submitted work
demonstrates that the students understand the difference between actions and behaviours). All
relevant requirements have been addressed.
1 mark - The implementation does not use some engine classes as intended (e.g. behaviours are
created for some actions that do not need it, such as actions performed by the player) or includes
custom classes for functionality that could be implemented with the engine class (e.g.
created a custom ground class instead of using the ground class given in the engine package). Most
relevant requirements have been addressed.
0 marks - The engine has been modified in a minor or significant way OR the UML class diagram OR
the implementation is missing
UML syntax and clarity (2 points)
This item applies across all relevant requirements.
2 marks - Relevant (static and/or dynamic) diagrams are perfect in terms of syntax, with no
missing multiplicities, correct arrowheads for all relationships, and appropriate usage of realisation
for classes implementing interfaces, generalisation for classes or interfaces inheriting others, etc.
Diagram formatting is consistent and clear. All requested diagrams have been submitted.
1 mark - Diagram(s) contain some minor syntax errors, such as missing multiplicities for several
associations, inappropriate use of generalisation for classes implementing interfaces, realisation for
classes extending others, or classes extending multiple classes, etc. Nonetheless, the design can still
be understood by the TA with a little effort. Alternatively, there are several inconsistencies across
diagrams. All necessary diagrams have been submitted.
0 marks - Diagram(s) are significantly hard to understand or show major inconsistencies in formatting
and clarity, OR more than one required diagram is missing, OR they do not resemble a UML diagram
as required.
Alignment and design consistency (2 points) - incl.
Design rationale, code and UML diagrams
2 marks - The design rationale and UML diagrams are in perfect alignment with each other and
with the code implementation across all functional expectations, as per the relevant requirement(s). All relevant requirements have been addressed or attempted and they are covered in the
implementation, UML diagrams and design rationale.
1 mark - There are some small inconsistencies (that can be easily fixed) between the design
documents and the implementation, but all relevant requirements have been addressed or
attempted, and they are covered in the implementation, UML diagrams and design rationale.
0 marks - There are major inconsistencies (which would necessitate significant changes for
correction) or numerous smaller discrepancies distributed throughout the design documents and
the implementation. Alternatively, one or more than one required diagram or implemented
requirement is missing, or some submitted design documents do not resemble the required UML
diagram format.
Style & Javadoc (1 point)
1 mark - The code is properly documented with Javadoc across all functional expectations as per the
relevant requirement(s), including class-level and method-level documentation. The Google Java Style
guide is followed properly (e.g. package names are written in lowercase, attributes and variables
names are written in lowerCamelCase, class names are written in UpperCamelCase, etc.). All relevant
requirements have been addressed or attempted.
0.5 marks - Some classes and methods are missing Javadoc documentation OR some classes do not
follow the Google Java style guide
0 marks - Most classes and methods are missing Javadoc documentation OR The Google Java style
guide is not followed.
Git usage (2 points)
2 marks - At least 15 meaningful commits have been logged (with meaningful comments) each with
a descriptive commit comment (note: default comments from the web UI don't count.), ideally, one
commit per week previous to the submission deadline.
1 mark - Between 7 and 14 meaningful commits have been logged (with meaningful comments)
each with a descriptive commit comment (note: default comments from the web UI don't count.) OR
there are more than 10 commits but ALL were done on the week of the submission deadline.
0 marks - There are less than 7 commits OR commit messages do not correspond to the changes in
the code.
IMPORTANT: if most of the code has been (in practice) uploaded in one go the whole assignment will not be
marked and 0 marks will be awarded. Project formatting and directory structure (1 point)
1 mark - If the directory structure suggested in the specification has been followed. All the documents
are easily found where expected.
0 marks - The suggested directory structure was not followed and some files may be hard to find.
Handover Interview (Compulsory)
COMPLETED - The student can answer all (or at least 2) questions during the handover interview
satisfactorily. The responses need to demonstrate that the student understands the various parts of
the submitted assignment.
NOT COMPLETED If two or more questions are not responded to adequately and sensibly. The
remaining question(s) is/are partly responded to, but it is unclear whether the student understands
their own work.
IMPORTANT: Failing to have meaningful commits (i.e. showing that the task was progressively completed) or
having most commit messages not correspond to the changes in the code, and/or failing the handover
interview would automatically flag this as a potential case of plagiarism. This may be further investigated using
a similarity check software, and zero marks would be awarded for the entire assignment.Assignment 1 Q&A Session
GMT20240823-081233_RecordingnewChat.txt
Direct link: https://monash.au.panopto.com/Panopto/Pages/Viewer.aspx?id=4b3d7250-f8b8-448a9ec3-b1d600d5f02a
Meeting
chat:
In the Q&A recording, a Shadowtree Fragment is represented with , , but in the specification, it is
represented with e . Please make sure to follow the Assignment 1 specification instead of the
recording!
相关推荐
西门子 G120 变频器报文
G120报文
UML——Interaction diagrams
交互图顾名思义是用来描述对象之间的交互过程的,其可分为两种图形:从事件顺序出发的顺序图,从交互关系理解的合作图。 在机房收费系统中的练习: 操作员所实现的功能交互(包括从登陆系统开始,实现的注册、充值、退卡一系列过程) 相应合作图如下: 对管理员对操作员的结账内容的时序图如下: 相应协作图为:
荔枝派Lichee Nano全志F1C100s烧录避坑指南:从Fel模式到SPI Flash完整流程
本文详细介绍了荔枝派Lichee Nano基于全志F1C100s芯片的SPI Flash烧录完整流程,从FEL模式进入技巧到定制化sunxi-tools编译,再到分区策略与实战烧录步骤。针对开发者常见的烧录程序问题提供了专业解决方案,帮助用户高效完成嵌入式系统部署。
A brief summary of UML & Rational Rose – Interaction Diagrams, Part III
5. Interaction Diagrams Interaction Diagrams consist of Sequence diagrams & Collaboration diagrams. Interaction diagrams are models that describe how groups of objects collaborate in...
YOLOv11改进策略【Neck】| 适用关键点检测:PSFM,深层语义融合模块 引入深层与浅层交叉注意力机制,动态建模不同层级的全局语义依赖关系
本文记录的是利用PSFM 模块改进 YOLOv11 的颈部融合部分,专门用于关键点检测。PSFM模块(Profound Semantic Fusion Module,深层语义融合模块) 通过在特征提取网络的深层引入跨模态交叉注意力机制,动态建模红外与可见光特征的全局语义依赖关系。本文将其应用到的颈部部分,融合深层与浅层特征,捕捉长距离语义关联,增强融合特征的判别性与场景理解能力,为检测头提供包含全局上下文的高层语义表示,从而提升模型在复杂场景下的目标检测准确率与语义推理鲁棒性。Rethinking the
用R来做一个临床研究亚组分析的森林图
在编程语言里R语言最强大的功能是做图功能,我们知道在做Meta分析的时候会需要做森林图,实际上我们在很多临床研究中也经常看到森林图,主要是亚组分析的森林图,比如下面这篇文章里的一个森林图: 今天就教教大家怎么用R语言来做上面这种亚组分析的森林图 1. 在Excel里编辑好数据,按照下面的格式整理,保存为csv格式 2. 下载安装R跟Rstudio R软件的下载地址: https://mirrors.tuna.tsinghua.edu.cn/CRAN/ Rstudio下
UML Distilled 3rd 学习笔记
一、Sequence Diagram Interaction diagrams 描述了一组对象之间的交互行为。其中最常用的就是 sequence diagram。 Sequence diagram 只是捕捉了一个特定场景中的交互情况,它使用 Use case 描述了一些实例对象以及它们之间消息的传递。 Interaction diagrams 并不能用于表示算法的细节、循环处理以及条件判断...
在 SAP 中实现“租赁资产”管理,核心是把 IFRS16/ASC842 等新租赁准则的要求落地到系统
摘要:本文详细介绍了在SAP S/4HANA系统中实现IFRS16/ASC842租赁准则的具体操作流程。主要内容包括:1) 系统前置配置,如激活租赁会计组件、定义租赁类型和会计科目;2) 租赁合同创建与主数据维护;3) 初始确认的会计处理;4) 日常折旧计提和租金支付流程;5) 合同变更与终止管理。通过RE-FX-LM模块与固定资产模块的集成,系统可自动生成使用权资产和租赁负债,支持从合同创建到报表披露的全生命周期管理,确保符合新租赁准则要求。
UML用户指南第二版-读书笔记-第2章-UML介绍
UML概述 UML是一种绘制软件蓝图的标准语言。可以用UML对软件密集型系统的制品进行可视化,规格化,构建和文档化。 UML仅仅只是一种语言,是软件开发方法的一部分 UML是独立于过程的,但是最好把它用于以用例为驱动,以体系结构为中心,迭代和增量的过程 UML可以告诉你如何创建模型,但是它没有说明应该在什么时候创建什么样的模型,因为这是软件开发过程的工作。 一个定义明确的过程将指导你决定生产什么制品
YOLOv5源码逐行超详细注释与解读(5)——配置文件yolov5s.yaml
全网最详细的YOLOv5源码解读之配置文件yaml。逐行注释,逐句讲解,一文带你了解yaml。小白必看!
详解FreeRTOS:事件标志组(高级篇—5)
事件组可以实现一对多,多对多的同步,即一个任务可以等待多个事件的发生。任务可以通过设置事件位来实现事件的触发和等待操作,FreeRTOS的事件仅用于同步,不提供数据传输功能。
UML的基本图(一)
A class diagram shows a set of classes, interfaces, and collaborations and their relationships. These diagrams are the most common diagram found in modeling object-oriented systems. Clas...
通信原理 | CRC循环冗余校验码(最简介明了的原理和matlab程序)
异或运算: 多项式: CRC校验中用到的除数,是由多项式的各项系数组成的,如下所示: 没有的项系数为0,比如:x5次方、x3次方下一步,在原数据串的末端加“0”0的数量由多项式决定具体来说,多项式的阶数是多少就加几个0 具体操作: 现在,我们有了除数,也有了处理过的数据串,如下所示: 就可以开始计算校验和 了将数据串第一个1与除数左对齐,按位进行异或操作: 将未处理的数据搬下来作为新的数据,重复操作: 将新的数据串第一个1与除数左对齐,再重复按位异或操作: 如此循环,直到所有数据都处理过
UML 2----Sequence Diagram
Sequence Diagrams A sequence diagram is a form of interaction diagram which shows objects as lifelines running down the page, with their interactions over time represented as messages drawn as arrows
华为的C语言编程规范.pdf
华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。
假人有限元模型
假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用
Interaction Diagrams
对象通过消息进行交互 顺序图: 边界对象(接口)/实体对象(存放信息的实体)/控制对象(协调边界和实体)相互区分 ref:参照其他顺序图 对象名:类名(对象名省略为匿名对象) 对象生命线 参与者实例 消息序号:消息名称:消息参数 反射性消息(消息由自己完成) 意味着消息执行的时间段,从其他消息中产生 不在同一个高度上 再顺序图上出现的是类的实例 在2....
ET2012新版免狗免安装绿色软件
ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,
UML统一建模语UML2和EnterpriseArchitect
其实前面的UML统一建模语言(一)所描述的都是UML1的内容,现在咱们聊一聊UML2。 UML2.x完全建立在UML1.x基础之上,大多数的UML1.x模型在UML2.x中都可用。但UML2.x在结构建模方面有一系列重大的改进,包括结构类、精确的接口和端口、拓展性、交互片断和操作符以及基于时间建模能力的增强。UML1.x从1997年发布的UML1.0到2003年3月发布1.5版本,而UML2.x...
Mermaid 类图(classDiagram)完整语法指南:从 UML 类与关系、命名空间到交互与样式配置
本文基于 mermaid 仓库官方文档 [docs/syntax/classDiagram.md](https://link.gitcode.com/i/9cceca0d2bf497e66ad81bde946d7df2),系统讲解 Mermaid 类图的全部语法要素:类与成员定义、八种 UML 关系、基数、命名空间(含嵌套与紧凑渲染)、注解、注释、方向控制、交互绑定、笔记与样式配置,并结合 [pa
Mermaid 类图(Class Diagram)语法完全指南:从 UML 建模到源码级配置
> 类图是面向对象建模的主要构件,用于对应用结构做一般性概念建模、把模型转化为代码的详细建模,也可用于数据建模。本文以 Mermaid 的官方语法文档为核心,系统讲解在 Mermaid 中编写 UML 类图所需的全部语法要素——从类的定义、成员、可见性、关系类型、命名空间、基数(多重性)、注解、注释、方向控制、交互回调到样式定制与配置项——并结合本仓库中的解析器、数据库层与渲染层源码,解释每一条语
Mermaid 序列图完整指南:从参与者语法到自定义配置的全面解析
Sequence diagram(序列图)是一种交互图(interaction diagram),用于展示多个进程如何彼此协作、以及这些交互按怎样的顺序发生。Mermaid 支持使用接近自然语言的纯文本语法来描述并渲染序列图,从而将时序逻辑直接嵌入 Markdown、网页或文档系统之中。阅读本文后,你将掌握序列图的参与者声明、消息箭头、循环与并行分支、激活条、背景高亮、自动编号、Actor 菜单乃
fireworks-tech-graph 样式-图型匹配矩阵:12 种视觉风格如何适配 12 类技术图型的选型实战指南
本指南以仓库中的 [样式-图型匹配矩阵](https://link.gitcode.com/i/f4ea5ad480e83326885473b11a168617) 为核心,系统讲解 fireworks-tech-graph 中 12 种视觉风格与架构图、UML、数据流、拓扑图等 12 类图型的适配关系。读完本文,你将掌握"为每一种图型挑选最合适风格"的完整方法论:包括风格 9–12 工程优先风格的
fireworks-tech-graph 完整指南:用自然语言生成几何校验级 SVG / PNG / GIF 技术架构图
`fireworks-tech-graph` 是一个同时兼容 **Codex 与 Claude Code** 的 Agent Skill:你只需用英文或中文描述系统,它就能产出几何校验过的 SVG 架构图、1920px 高分辨率 PNG、经语义校验的 SVG-to-GIF 动效,以及可离线交互的 HTML 技术图。读完本文,你将掌握它的安装方式、统一 CLI 全链路(validate → rend
fireworks-tech-graph 实战指南:自然语言一键生成几何安全的技术 SVG/PNG/GIF 架构图
> 本指南围绕开源仓库 `fireworks-tech-graph` 的官方文档([README.md](https://link.gitcode.com/i/0263e50eec1216a947aa826e9873e6e8))展开,完整讲解如何用一句自然语言描述,生成通过几何校验的 SVG 技术图、1920px 高清 PNG、经过语义验证的 SVG-to-GIF 动效,以及可离线交互的 HTML
使用 fireworks-tech-graph Agent Skill 生成几何安全的技术图表:安装、CLI、12 种风格与语义动效实战
> 本文围绕当前仓库中随附的 Agent Skill 资产 `fireworks-tech-graph`(快照位于 [.agents/skills/fireworks-tech-graph/](https://link.gitcode.com/i/3510dcb0ddb6d757ac32b80f903f6190),来源与锁定规则见 [docs/agents/skills.md](https://l
Fireworks Tech Graph 工程化路线图解析:从版本化 IR 到 Agent Skill 分发
本文以仓库 [docs/ROADMAP.md](https://link.gitcode.com/i/3bed1ce696cf7471f78bca078e60c3ea) 为骨架,系统解读 Fireworks Tech Graph 的工程化演进路线:v1.1.0 已交付的六大能力(版本化 Diagram IR 与 Schema、几何安全渲染与制品审计、确定性布局报告、完整 Agent Skill 安
SVG 技术架构图布局最佳实践:fireworks-tech-graph 的通用布局规则与工程化校验指南
本文是 fireworks-tech-graph 项目中 `svg-layout-best-practices.md` 布局规范的完整实战解读。无论你使用哪一种视觉风格(Flat Icon、Claude Warm、Blueprint 等),布局规则都是跨风格通用的硬性约束:组件间距、箭头路由、标签防碰撞、Z-Index 渲染顺序,以及最终通过校验器自动验收。读完本文,你将掌握一套可直接落地到任何
8100



被折叠的 条评论
为什么被折叠?



