Hound
ELINT for DCS

• Index

Contents

• Getters and Setters
• Class HOUND.Comms.Manager
• Control functions
• Message Handling
• abstract methods

Modules

• HOUND
• HOUND.Logger
• HOUND.DB
• HOUND.Config
• HOUND.Utils
• HOUND.EventHandler
• HOUND.Contact.Base
• HOUND.Contact.Estimator
• HOUND.Contact.Datapoint
• HOUND.Contact.Emitter
• HOUND.Contact.Site
• HOUND.Comms.Manager
• HOUND.Comms.InformationSystem
• HOUND.Comms.Controller
• HOUND.Comms.Notifier
• HOUND.ElintWorker
• HOUND.ContactManager
• HOUND.Sector

Scripts

• HoundElint

Module HOUND.Comms.Manager

Hound Comms Manager (Base class)

Getters and Setters

HOUND.Comms.Manager:isEnabled ()	is comm instance enabled
HOUND.Comms.Manager:getSettings (key)	get value of setting in settings
HOUND.Comms.Manager:setSettings (key, value)	set value of setting in settings
HOUND.Comms.Manager:enableText ()	enable text messages
HOUND.Comms.Manager:disableText ()	disable text messages
HOUND.Comms.Manager:enableTTS ()	enable text messages
HOUND.Comms.Manager:disableTTS ()	disable text messages
HOUND.Comms.Manager:enableAlerts ()	enable Alert messages
HOUND.Comms.Manager:disableAlerts ()	disable Alert messages
HOUND.Comms.Manager:setTransmitter (transmitterName)	set transmitter
HOUND.Comms.Manager:removeTransmitter ()	Remove transmitter
HOUND.Comms.Manager:getCallsign ()	get configured callsign
HOUND.Comms.Manager:setCallsign (callsign)	set callsign
HOUND.Comms.Manager:getFreq ()	get first configured frequency
HOUND.Comms.Manager:getFreqs ()	get table of all configured frequencies
HOUND.Comms.Manager:getAlias ()	get configured Frequeny Alias
HOUND.Comms.Manager:setAlias (alias)	set Frequeny Alias

Class HOUND.Comms.Manager

HOUND.Comms.Manager:create (sector, houndConfig[, settings])

HOUND.Comms.Manager create

Control functions

HOUND.Comms.Manager:updateSettings (settings)	Update settings
HOUND.Comms.Manager:enable ()	enable comm instance
HOUND.Comms.Manager:disable ()	disable comm instance

Message Handling

HOUND.Comms.Manager:addMessageObj (obj)	Add message object to queue
HOUND.Comms.Manager:addMessage (coalition, msg[, prio])	add message to queue
HOUND.Comms.Manager:addTxtMsg (coalition, msg, prio)	add text message to queue
HOUND.Comms.Manager:getNextMsg ()	Get next message from queue
HOUND.Comms.Manager:getTransmitterPos ()	returns configured transmitter position
HOUND.Comms.Manager.TransmitFromQueue (gSelf)	Trsnsmit next message from queue

abstract methods

HOUND.Comms.Manager:startCallbackLoop ()	start loop placeholder
HOUND.Comms.Manager:stopCallbackLoop ()	stop loop placeholder
HOUND.Comms.Manager:SetMsgCallback ()	SetMsgCallback placeholder
HOUND.Comms.Manager:runCallback ()	run callback message scheduler placeholder

Getters and Setters

HOUND.Comms.Manager:isEnabled ()

is comm instance enabled

Returns:

Bool True if enabled

HOUND.Comms.Manager:getSettings (key)

get value of setting in settings

Parameters:

• key config key requested

Returns:

settings[key]

HOUND.Comms.Manager:setSettings (key, value)

set value of setting in settings

Parameters:

• key config key requested
• value desired value

HOUND.Comms.Manager:enableText ()

enable text messages

HOUND.Comms.Manager:disableText ()

disable text messages

HOUND.Comms.Manager:enableTTS ()

enable text messages

HOUND.Comms.Manager:disableTTS ()

disable text messages

HOUND.Comms.Manager:enableAlerts ()

enable Alert messages

HOUND.Comms.Manager:disableAlerts ()

disable Alert messages

HOUND.Comms.Manager:setTransmitter (transmitterName)

set transmitter

Parameters:

• transmitterName (String) name of the Unit which will be transmitter

HOUND.Comms.Manager:removeTransmitter ()

Remove transmitter

HOUND.Comms.Manager:getCallsign ()

get configured callsign

Returns:

string. currently configured callsign

HOUND.Comms.Manager:setCallsign (callsign)

set callsign

Parameters:

• callsign string

HOUND.Comms.Manager:getFreq ()

get first configured frequency

Returns:

string first frequency configured

HOUND.Comms.Manager:getFreqs ()

get table of all configured frequencies

Returns:

table of all configured frequencies

HOUND.Comms.Manager:getAlias ()

get configured Frequeny Alias

Returns:

string. currently configured Frequeny Alias

HOUND.Comms.Manager:setAlias (alias)

set Frequeny Alias

Parameters:

• alias string

Class HOUND.Comms.Manager

HOUND.Comms.Manager:create (sector, houndConfig[, settings])

HOUND.Comms.Manager create

Parameters:

• sector string name of parent sector
• houndConfig HoundConfig instance
• settings table table containing comms instance settings (optional)

Returns:

CommsManager Instance

Control functions

HOUND.Comms.Manager:updateSettings (settings)

Update settings

Parameters:

• settings #table a settings table

HOUND.Comms.Manager:enable ()

enable comm instance

HOUND.Comms.Manager:disable ()

disable comm instance

Message Handling

HOUND.Comms.Manager:addMessageObj (obj)

Add message object to queue

Parameters:

• obj table the message object to be added

HOUND.Comms.Manager:addMessage (coalition, msg[, prio])

add message to queue

Parameters:

• coalition integer coalition to transmit for
• msg string Message to be added
• prio integer message priority in queue (optional)

HOUND.Comms.Manager:addTxtMsg (coalition, msg, prio)

add text message to queue

Parameters:

• coalition
• msg
• prio TODO FIX!

HOUND.Comms.Manager:getNextMsg ()

Get next message from queue

HOUND.Comms.Manager:getTransmitterPos ()

returns configured transmitter position

Returns:

DCS position of transmitter or nil if none set

HOUND.Comms.Manager.TransmitFromQueue (gSelf)

Trsnsmit next message from queue

Parameters:

• gSelf #Table pointer to self

Returns:

time of next queue check

abstract methods

HOUND.Comms.Manager:startCallbackLoop ()

start loop placeholder

HOUND.Comms.Manager:stopCallbackLoop ()

stop loop placeholder

HOUND.Comms.Manager:SetMsgCallback ()

SetMsgCallback placeholder

HOUND.Comms.Manager:runCallback ()

run callback message scheduler placeholder