Module CommandCenter
A COMMANDCENTER is the owner of multiple missions within MOOSE.
A COMMANDCENTER governs multiple missions, the tasking and the reporting.
Global(s)
| COMMANDCENTER | |
| REPORT |
Type COMMANDCENTER
| COMMANDCENTER:AddMission(Mission) |
Add a MISSION to be governed by the HQ command center. |
| COMMANDCENTER.ClassName | |
| COMMANDCENTER.CommandCenterCoalition | |
| COMMANDCENTER.CommandCenterMenu | |
| COMMANDCENTER.CommandCenterName | |
| COMMANDCENTER.CommandCenterPositionable | |
| COMMANDCENTER:GetMenu() |
Gets the commandcenter menu structure governed by the HQ command center. |
| COMMANDCENTER:GetMissions() |
Get the Missions governed by the HQ command center. |
| COMMANDCENTER:GetName() |
Gets the name of the HQ command center. |
| COMMANDCENTER:GetPositionable() |
Gets the POSITIONABLE of the HQ command center. |
| COMMANDCENTER.HQ | |
| COMMANDCENTER:HasGroup(Wrapper, MissionGroup) |
Checks of the COMMANDCENTER has a GROUP. |
| COMMANDCENTER:MessageToAll(Message) |
Send a CC message to the coalition of the CC. |
| COMMANDCENTER:MessageToCoalition(Message) |
Send a CC message to the coalition of the CC. |
| COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name) |
Send a CC message to a GROUP. |
| COMMANDCENTER.Name | |
| COMMANDCENTER:New(CommandCenterPositionable, CommandCenterName) |
The constructor takes an IDENTIFIABLE as the HQ command center. |
| COMMANDCENTER:RemoveMission(Mission) |
Removes a MISSION to be governed by the HQ command center. |
| COMMANDCENTER:ReportDetails(ReportGroup, Task) |
Report the status of a Task to a Group. |
| COMMANDCENTER:ReportSummary(ReportGroup) |
Report the status of all MISSIONs to a GROUP. |
| COMMANDCENTER:SetMenu() |
Sets the menu structure of the Missions governed by the HQ command center. |
Type REPORT
| REPORT:Add(Text) |
Add a new line to a REPORT. |
| REPORT.ClassName | |
| REPORT:New(Title) |
Create a new REPORT. |
| REPORT:Text(Delimiter) |
Produces the text of the report, taking into account an optional delimeter, which is \n by default. |
Global(s)
Type CommandCenter
Type COMMANDCENTER
The COMMANDCENTER class
Field(s)
- COMMANDCENTER:AddMission(Mission)
-
Add a MISSION to be governed by the HQ command center.
Parameter
-
Tasking.Mission#MISSION Mission:
Return value
-
- #string COMMANDCENTER.ClassName
- #string COMMANDCENTER.CommandCenterName
- COMMANDCENTER:GetMenu()
-
Gets the commandcenter menu structure governed by the HQ command center.
Return value
- COMMANDCENTER:GetMissions()
-
Get the Missions governed by the HQ command center.
Return value
#list: Tasking.Mission#MISSION>
- COMMANDCENTER:GetName()
-
Gets the name of the HQ command center.
Return value
#string:
- COMMANDCENTER:GetPositionable()
-
Gets the POSITIONABLE of the HQ command center.
Return value
- COMMANDCENTER:HasGroup(Wrapper, MissionGroup)
-
Checks of the COMMANDCENTER has a GROUP.
Parameters
-
Wrapper: Group#GROUP -
MissionGroup:
Return value
#boolean:
-
- COMMANDCENTER:MessageToAll(Message)
-
Send a CC message to the coalition of the CC.
Parameter
-
Message:
-
- COMMANDCENTER:MessageToCoalition(Message)
-
Send a CC message to the coalition of the CC.
Parameter
-
Message:
-
- COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)
-
Send a CC message to a GROUP.
Parameters
-
#string Message: -
Wrapper.Group#GROUP TaskGroup: -
#sring Name: (optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.
-
- #string COMMANDCENTER.Name
- COMMANDCENTER:New(CommandCenterPositionable, CommandCenterName)
-
The constructor takes an IDENTIFIABLE as the HQ command center.
Parameters
-
Wrapper.Positionable#POSITIONABLE CommandCenterPositionable: -
#string CommandCenterName:
Return value
-
- COMMANDCENTER:RemoveMission(Mission)
-
Removes a MISSION to be governed by the HQ command center.
The given Mission is not nilified.
Parameter
-
Tasking.Mission#MISSION Mission:
Return value
-
- COMMANDCENTER:ReportDetails(ReportGroup, Task)
-
Report the status of a Task to a Group.
Report the details of a Mission, listing the Mission, and all the Task details.
Parameters
-
ReportGroup: -
Task:
-
- COMMANDCENTER:ReportSummary(ReportGroup)
-
Report the status of all MISSIONs to a GROUP.
Each Mission is listed, with an indication how many Tasks are still to be completed.
Parameter
-
ReportGroup:
-
- COMMANDCENTER:SetMenu()
-
Sets the menu structure of the Missions governed by the HQ command center.
Type REPORT
The REPORT class
Field(s)
- REPORT:Add(Text)
-
Add a new line to a REPORT.
Parameter
-
#string Text:
Return value
-
- #string REPORT.ClassName
- REPORT:New(Title)
-
Create a new REPORT.
Parameter
-
#string Title:
Return value
-
- REPORT:Text(Delimiter)
-
Produces the text of the report, taking into account an optional delimeter, which is \n by default.
Parameter
-
#string Delimiter: (optional) A delimiter text.
Return value
#string: The report text.
-