-
Notifications
You must be signed in to change notification settings - Fork 0
/
CALM.ctxt
37 lines (37 loc) · 4.92 KB
/
CALM.ctxt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#BlueJ class context
comment0.target=CALM
comment0.text=\r\n\ Write\ a\ description\ of\ interface\ CALM\ here.\r\n\ \r\n\ @author\ (your\ name)\ \r\n\ @version\ (a\ version\ number\ or\ a\ date)\r\n
comment1.params=
comment1.target=java.lang.String\ toString()
comment1.text=\r\n\ Returns\ all\ of\ the\ details\ of\ all\ rooms\ including\ the\ passes\r\n\ currently\ in\ each\ room,\ or\ "No\ passes"\r\n\ @return\ all\ of\ the\ details\ of\ all\ rooms\ including\ location\ \r\n\ of\ all\ passes\ currently\ in\ each\ room,\ or\ "No\ passes"\ \r\n
comment10.params=
comment10.target=void\ resetPasses()
comment10.text=\ Resets\ all\ passes\ \r\n
comment11.params=
comment11.target=void\ evacuation()
comment11.text=\ Evacuates\ all\ passes\ from\ all\ rooms\ of\ the\ site\ into\ the\ outside\ in\ the\ case\ of\ emergency\r\n\ if\ the\ room\ has\ no\ one\ in\ it\ or\ the\ room\ is\ the\ gathering\ point\ in\ the\ case\ of\ emergency,\ the\ \r\n\ room\ is\ ignored,\ however,\ is\ all\ other\ cases,\ every\ pass\ within\ any\ other\ room\ will\ be\ transfered\ through\r\n\ the\ proper\ emergency\ door\ into\ the\ outside,\ which\ is\ the\ gathering\ point\ in\ the\ case\ \r\n\ of\ emergency\r\n
comment2.params=
comment2.target=java.lang.String\ getAllPassesInAllRooms()
comment2.text=Returns\ a\ String\ representation\ of\ all\ the\ passes\ in\ all\ rooms\r\n\ @return\ a\ String\ representation\ of\ all\ passes\ in\ all\ rooms,\ room\ code\r\n\ and\ name\ should\ be\ included\ at\ the\ start\ of\ the\ list\r\n
comment3.params=ps
comment3.target=int\ findPass(int)
comment3.text=Returns\ the\ name\ of\ the\ room\ which\ contains\ the\ specified\ pass\ or\ null\r\n\ @param\ ps\ -\ the\ specified\ pass\r\n\ @return\ the\ number\ of\ the\ Room\ which\ contains\ the\ pass,\ or\ -1\r\n
comment4.params=rm
comment4.target=int\ getRoomNo(java.lang.String)
comment4.text=\ Given\ the\ name\ of\ a\ room,\ returns\ the\ room\ code\r\n\ or\ null\ if\ room\ does\ not\ exist\r\n\ @param\ name\ of\ room\r\n\ @return\ number\ of\ room,\ or\ -1\ if\ the\ room\ does\ not\ exist\r\n
comment5.params=rmNo
comment5.target=java.lang.String\ getAllPassesInRoom(int)
comment5.text=Returns\ a\ String\ representation\ of\ all\ the\ passes\ in\ specified\ room\r\n\ @roomCode\ the\ room\ code\r\n\ @return\ a\ String\ representation\ of\ all\ passes\ in\ specified\ room,\ or\r\n\ "No\ such\ room"\r\n
comment6.params=pNo
comment6.target=java.lang.String\ showPass(int)
comment6.text=\ Returns\ a\ String\ with\ all\ of\ the\ details\ of\ a\ Pass\r\n\ @param\ passNo\ is\ the\ pass\ number\r\n\ @return\ all\ details\ of\ the\ Pass,\ or\ "No\ such\ Pass"\r\n
comment7.params=dNo
comment7.target=java.lang.String\ showDoor(int)
comment7.text=\ Returns\ a\ String\ with\ all\ of\ the\ details\ of\ a\ Door\r\n\ @param\ doorNo\ is\ the\ door\ number\r\n\ @return\ all\ details\ of\ the\ door,\ or\ "No\ such\ Door"\r\n
comment8.params=psId\ doorNo
comment8.target=boolean\ canMove(int,\ int)
comment8.text=Returns\ true\ if\ a\ Pass\ is\ allowed\ to\ move\ using\ the\ door,\ false\ otherwise\r\n\ A\ move\ can\ be\ made\ if\:\ \ \r\n\ the\ protection\ rating\ of\ the\ pass\ \ >\=\ the\ danger\ rating\ of\ the\ destination\ room\r\n\ AND\ the\ destination\ room\ is\ not\ full\r\n\ AND\ the\ pass\ has\ hours\ left\ >\=\ limit\ of\ the\ destination\ room\r\n\ AND\ the\ pass\ is\ currently\ in\ the\ source\ room\r\n\ AND\ the\ pass\ id\ is\ for\ a\ pass\ in\ the\ system\r\n\ AND\ the\ door\ number\ is\ the\ number\ for\ a\ door\ in\ the\ system\r\n\ @param\ psId\ is\ the\ id\ of\ the\ pass\ requesting\ the\ move\r\n\ @param\ doorNo\ is\ the\ number\ of\ the\ door\ through\ which\ the\ pass\ wants\ to\ move\r\n\ @return\ true\ if\ the\ pass\ is\ allowed\ in\ the\ move,\ false\ otherwise\ \r\n
comment9.params=psId\ doorNo
comment9.target=java.lang.String\ move(int,\ int)
comment9.text=Returns\ the\ result\ of\ a\ pass\ requesting\ to\ move\ by\ Door.\r\n\ A\ move\ will\ be\ successful\ if\:\ \ \r\n\ the\ protection\ rating\ of\ the\ pass\ \ >\=\ the\ danger\ rating\ of\ the\ destination\ room\r\n\ AND\ the\ destination\ room\ is\ not\ full\r\n\ AND\ the\ pass\ has\ sufficient\ hours\ left\ >\=\ limit\ of\ the\ destination\ room\r\n\ AND\ the\ pass\ is\ currently\ in\ the\ source\ room\r\n\ AND\ the\ pass\ id\ is\ for\ a\ pass\ in\ the\ system\r\n\ AND\ the\ door\ number\ is\ the\ number\ for\ a\ door\ in\ the\ system\r\n\ If\ the\ move\ can\ be\ made,\ the\ pass\ information\ is\ removed\ from\ the\ source\r\n\ room,\ added\ to\ the\ destination\ room\ and\ a\ suitable\ message\ returned.\r\n\ If\ move\ cannot\ be\ made,\ the\ state\ of\ the\ system\ remains\ unchanged\r\n\ and\ a\ message\ specifying\ the\ reason\ is\ returned.\r\n\ @param\ psId\ is\ the\ id\ of\ the\ pass\ requesting\ the\ move\r\n\ @param\ doorNo\ is\ the\ number\ of\ the\ door\ through\ which\ the\ pass\ wants\ to\ move\r\n\ @return\ a\ String\ giving\ the\ result\ of\ the\ request\ \r\n
numComments=12