MIST msgLeadingLL
mist.msgLeadingLL
| Added with: Mist 3.0 |
| Description |
| Utilizes mist.getLLString and mist.message.add functions to display the coordinates in the Latitude and Longitude format of the average position of the concentration of units most in the heading direction to the defined accuracy. The units are defined by the table UnitNameTable and the concentration is within the specified radius. If the optional variable DMS exists, the format will be in Degrees Minutes Seconds. If DMS is not present the format will be in Degrees Minutes Thousandths of Minutes. The message will be displayed to the specified recipients for the given displayTime. If text is provided, the coordinates will be added to the end of the text message. |
| Syntax |
| nothing mist.msgLeadingLL(table vars ) |
| Valid Input Values: |
|
vars tables have the following recognized fields( required entries in blue, optional in green): vars =
{
units = UnitNameTable units,
radius = number radius,
displayTime = number displayTime,
msgFor = table msgFor,
heading/headingDegrees = number/number heading/headingDegrees,
text = string text,
DMS = boolean DMS,
}
units is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). radius is the radius of units to be considered. displayTime is the time in seconds the message will display for. msgFor is the list of message recipients as outlined in the mist.message.add documentation heading/headingDegrees heading or headingDegrees define the orientation units must be heading in to be considered. heading is measured in radians. headingDegrees is measured in degrees text is an optional variable of text to be displayed before the LL coordinates DMS is a boolean value if present will display coordinate in Degrees Minutes Seconds. If not present the format will be in Degrees Minutes Thousandths of Minutes. |
| Return value: |
| nothing |
| Return example: |
| nothing |
| Usage Examples: |
|
| Notes: |
| Related Functions |
| messageAdd, removeById, remove , msgMGRS, msgLL, msgBR, msgBRA, msgBullseye, msgLeadingLL, msgLeadingMGRS, msgLeadingBR |
