Module HOUND.Contact.Emitter
HOUND.Contact.Emitter (Extends HOUND.Contact.Base)
Contact class.
containing related functions
-
HOUND.Contact.Emitter.calculatePoly (uncertenty_data[, numPoints[, refPos]])
-
calculate uncertenty Polygon from data
Parameters:
- uncertenty_data
uncertenty data table
- numPoints
number of datapoints in the polygon
(optional)
- refPos
center of the polygon (DCS point)
(optional)
Returns:
Polygon created by inputs
-
HOUND.Contact.Emitter:drawAreaMarker (numPoints)
-
Draw marker Polygon
Parameters:
- numPoints
integer
number of points to draw (only 1,4,8 and 16 are valid)
-
HOUND.Contact.Emitter:updateMarker (MarkerType)
-
Update marker positions
Parameters:
- MarkerType
type of marker to use
HOUND.Contact decleration (Extends HOUND.Contact.Base)
Contact class. containing related functions
-
HOUND.Contact.Emitter:New (DcsObject, HoundCoalition[, ContactId])
-
create new HOUND.Contact instance
Parameters:
- DcsObject
emitter DCS Unit
- HoundCoalition
coalition Id of Hound Instace
- ContactId
specify uid for the contact. if not present Unit ID will be used
(optional)
Returns:
HOUND.Contact instance
-
HOUND.Contact.Emitter:destroy ()
-
Destructor function
-
HOUND.Contact.Emitter:getName ()
-
Get contact name
Returns:
String
-
HOUND.Contact.Emitter:getType ()
-
Get contact type name
Returns:
String
-
HOUND.Contact.Emitter:getId ()
-
Get contact UID
Returns:
Number
-
HOUND.Contact.Emitter:getTrackId ()
-
get Contact Track ID
Returns:
string
-
HOUND.Contact.Emitter:getPos ()
-
get current extimted position
Returns:
DCS point - estimated position
-
HOUND.Contact.Emitter:getWavelenght (isTracking)
-
get radar transmission wavelength
@ param[type=bool] isTracking detemins which frequency range will be retunred
Parameters:
-
HOUND.Contact.Emitter:getElev ()
-
get current estimated position elevation
Returns:
int
Elevation in ft.
-
HOUND.Contact.Emitter:getLife ()
-
get unit health
Returns:
-
unit HP points
-
Unit HP in percent
-
HOUND.Contact.Emitter:isAlive ()
-
check if contact DCS Unit is still alive
Returns:
bool
True if object is considered Alive
-
HOUND.Contact.Emitter:setDead ()
-
set internal alive flag to false
This is internal function ment to be called on "S_EVENT_DEAD"
unit will be changed to Unit.name because DCS will remove the unit at the end of the event.
-
HOUND.Contact.Emitter:updateDeadDcsObject ()
-
update the internal DCS Object
Since March 2022, Dead units are converted to staticObject on delayed death
-
HOUND.Contact.Emitter:CleanTimedout ()
-
Remove stale datapoints
-
HOUND.Contact.Emitter:countPlatforms ([skipStatic])
-
return number of platforms
Parameters:
- skipStatic
if true, will ignore static platforms in count
(optional)
Returns:
Number of platfoms
-
HOUND.Contact.Emitter:countDatapoints ()
-
returns number of datapoints in contact
Returns:
Number of datapoint
-
HOUND.Contact.Emitter:AddPoint (datapoint)
-
Add Datapoint to content
Parameters:
-
HOUND.Contact.Emitter.triangulatePoints (earlyPoint, latePoint)
-
Take two HOUND.Contact.Datapoints and return the location of intersection
Parameters:
Returns:
Position
-
HOUND.Contact.Emitter.calculateEllipse (estimatedPositions[, refPos[, giftWrapped]])
-
Calculate Cotact's Ellipse of uncertenty
Parameters:
- estimatedPositions
List of estimated positions
- refPos
reference position to use for computing the uncertenty ellipse. (will use cluster avarage if none provided)
(optional)
- giftWrapped
pass true if estimatedPosition is just a giftWrap polygon point set (closed polygon, not a point cluster)
(optional)
Returns:
None (updates self.uncertenty_data)
-
HOUND.Contact.Emitter:calculateExtrasPosData (pos)
-
calculate additional position data
Parameters:
- pos
basic position table to be filled with extended data
Returns:
pos input object, but with more data
-
HOUND.Contact.Emitter:processIntersection (targetTable, point1, point2)
-
process the intersection
Parameters:
-
HOUND.Contact.Emitter:processData ()
-
process data in contact
Returns:
HoundEvent id (HOUND.EVENTS)
-
HOUND.Contact.Emitter:useUnitPos (unitPosMarker)
-
Use DCS Unit Position as contact position
Parameters:
- unitPosMarker
marker type to use for unit (see HOUND.MARKER)
-
HOUND.Contact.Emitter:export ()
-
Generate contact export object
Returns:
exported object
-
HOUND.Contact.Emitter:getTextData (utmZone, MGRSdigits)
-
return Information used in Text messages
Parameters:
- utmZone
(bool) True will add UTM zone to response
- MGRSdigits
(Number) number of digits in the MGRS part of the response (eg. 2 = 12, 5=12345)
Returns:
GridPos (string) MGRS grid position (eg. "CY 564 123", "DN 2 4")
Return BE (string) Bullseye position string (eg. "035/15", "187/120")
-
HOUND.Contact.Emitter:getTtsData (utmZone, MGRSdigits)
-
return Information used in TTS messages
Parameters:
- utmZone
(bool) True will add UTM zone to response
- MGRSdigits
(Number) number of digits in the MGRS part of the response (eg. 2 = 12, 5=12345)
Returns:
GridPos (string) MGRS grid position (eg. "Charlie Yankee one two Three four")
Return BE (string) Bullseye position string (eg. "Zero Three Five 15")
-
HOUND.Contact.Emitter:generateTtsBrief (NATO)
-
Generate TTS brief for the contact (for ATIS)
Parameters:
- NATO
(bool) True will generate NATO Brevity brief
Returns:
string containing
-
HOUND.Contact.Emitter:generateTtsReport ([useDMM[, preferMGRS[, refPos]]])
-
Generate TTS report for the contact (for controller)
Parameters:
- useDMM
if true. output will be DM.M rather then the default DMS
(optional)
- preferMGRS
if true output will be MGRS rather then Lat/Lon (not Currently used)
(optional)
- refPos
position of reference point for BR (Not Currently Used)
(optional)
Returns:
generated message
-
HOUND.Contact.Emitter:generateTextReport ([useDMM[, refPos]])
-
Generate Text report for the contact (for controller)
Parameters:
- useDMM
if true. output will be DM.M rather then the default DMS
(optional)
- refPos
position of reference point for BR
(optional)
Returns:
generated message
-
HOUND.Contact.Emitter:getRadioItemText ()
-
generate Text for the Radio menu item
Returns:
string
-
HOUND.Contact.Emitter:generatePopUpReport (isTTS, sectorName)
-
generate PopUp report
Parameters:
- isTTS
Bool. If true message will be for TTS. False will make a text message
- sectorName
string
Name of primary sector if present function will only return sector data
Returns:
string. compiled message
-
HOUND.Contact.Emitter:generateDeathReport (isTTS, sectorName)
-
generate Radar dead report
Parameters:
- isTTS
Bool. If true message will be for TTS. False will make a text message
- sectorName
string
Name of primary sector if present function will only return sector data
Returns:
string. compiled message
-
HOUND.Contact.Emitter:generateIntelBrief ()
-
Generate Intel brief Message (for export)
Returns:
string - compiled message