CommBaseManager (Neptus Package API)

java.lang.Object
- pt.up.fe.dceg.neptus.util.comm.manager.CommBaseManager<M,Mi,C,I,L>

Type Parameters:

M - extends IMessage

Mi - extends MessageInfo

C - extends VehicleCommInfo

I - its the identifier

L - extends CommManagerStatusChangeListener

All Implemented Interfaces:

pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>

Direct Known Subclasses:

ImcMsgManager
```
public abstract class CommBaseManager<M extends IMessage,Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,C extends SystemCommBaseInfo<M,Mi,I>,I,L extends CommManagerStatusChangeListener>
extends java.lang.Object
implements pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>
```
Every Comm. Manager should be a singleton. So it MUST be a method called getManager() which SOULD BE public and static.

Author:

Paulo Dias

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`arrivalDeltaTxRxTimeNanosLastMsg`
`protected double`	`arrivalLastSecondMsgTime`
`protected double`	`arrivalMessageFreq`
`protected long`	`arrivalMsgsInLastSec`
`protected double`	`arrivalTimeMillisLastMsg`
`protected java.util.LinkedHashMap<I,C>`	`commInfo`
`protected long`	`counter`
`protected java.util.LinkedList<Mi>`	`infoQueue`
`protected boolean`	`isActive`
`protected pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>`	`lastListener`
`protected java.util.LinkedHashMap<java.lang.String,java.lang.Long>`	`lastReceivedTime`
`protected java.util.LinkedHashSet<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>>`	`listeners`
`protected java.util.LinkedHashMap<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>,MessageListenerQueueProvider<Mi,M>>`	`listenersQueueProvider`
`static int`	`MANAGER_ERROR`
`static int`	`MANAGER_START`
`static int`	`MANAGER_STOP`
`protected pt.up.fe.dceg.neptus.util.comm.manager.CommonCommBaseImplementation.MessageProcessor`	`messageProcessor`
`protected long`	`minDelay` Is the separation time of each message type that is warn to the listeners.
`protected java.util.LinkedList<M>`	`msgQueue`
`protected PreferencesListener`	`preferencesListener`
`protected double`	`processDeltaTxRxTimeNanosLastMsg`
`protected double`	`processLastSecondMsgTime`
`protected double`	`processMessageFreq`
`protected long`	`processMsgsInLastSec`
`protected double`	`processTimeMillisLastMsg`
`protected int`	`queueMaxSize`
`protected long`	`seqInstanceNr`
`protected boolean`	`started`
`protected java.util.LinkedHashSet<L>`	`statusListeners`
`static int`	`SYS_COMM_OFF`
`static int`	`SYS_COMM_ON`
`static int`	`SYS_CTRL_CHANGED`
`static int`	`SYS_NEW`
`protected java.lang.Thread`	`timerThread`
`protected static boolean`	`useListenersQueues`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CommBaseManager()

Constructors
Modifier	Constructor and Description
`protected`	`CommBaseManager()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)` For public channel Don't need to override this method.
`boolean`	`addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener, I vehicleCommId)` Don't need to override this method.
`boolean`	`addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener, I vehicleCommId, MessageFilter<Mi,M> filter)` Don't need to override this method.
`boolean`	`addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener, MessageFilter<Mi,M> filter)` Same as `addListener(MessageListener)` but with a filter.
`boolean`	`addStatusListener(L listener)` This is related to the status change listeners (`statusListeners` ).
`void`	`clearMsgQueue()` To force the clear of the messages queue.
`double`	`getArrivalDeltaTxRxTimeNanosLastMsg()`
`double`	`getArrivalMessageFreq()` Don't need to override this method.
`double`	`getArrivalTimeMillisLastMsg()` Don't need to override this method.
`java.util.LinkedHashMap<I,C>`	`getCommInfo()` Don't need to override this method.
`C`	`getCommInfoById(I id)` Don't need to override this method.
`pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>`	`getLastListener()` Don't need to override this method.
`protected java.util.LinkedHashSet<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>>`	`getListeners()` Don't need to override this method.
`java.lang.String`	`getListenersAsHtmlFragment()`
`java.lang.String`	`getListenersAsHtmlFragment(I id)`
`protected java.util.LinkedHashMap<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>,MessageListenerQueueProvider<Mi,M>>`	`getListenersQueueProvider()`
`int`	`getListenersSize()` Don't need to override this method.
`protected long`	`getMinDelay()` Don't need to override this method.
`int`	`getMsgQueueLength()` Don't need to override this method.
`long`	`getNextSeqInstanceNr()` Don't need to override this method.
`int`	`getNumberOfSystems()` Don't need to override this method.
`double`	`getProcessDeltaTxRxTimeNanosLastMsg()`
`double`	`getProcessMessageFreq()` Don't need to override this method.
`double`	`getProcessTimeMillisLastMsg()` Don't need to override this method.
`long`	`getSeqInstanceNr()` Don't need to override this method.
`protected java.util.LinkedHashSet<L>`	`getStatusListeners()` This is related to the status change listeners (`statusListeners`).
`java.lang.String`	`getStatusListenersAsHtmlFragment()`
`int`	`getStatusListenersSize()` This is related to the status change listeners (`statusListeners` ).
`java.lang.Thread`	`getTimerThread()`
`protected abstract boolean`	`initManagerComms()` Initialize the comms. but don't start.
`C`	`initSystemCommInfo(I vIdS, java.lang.String inetAddress)` Initialize a vehicle comms (as in `SystemCommBaseInfo`).
`boolean`	`isActive()`
`boolean`	`isRunning()` Don't need to override this method.
`void`	`onMessage(Mi info, M msg)` This is from `#openNode`.
`protected void`	`processMessage(Mi info, M msg)` This calls: if (processMsgLocally(info, msg)) warnListeners(info, msg); Normally this method is NOT needed to be overwritten.
`protected abstract boolean`	`processMsgLocally(Mi info, M msg)` To be used to process the message locally.
`boolean`	`removeListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)` For public channel Don't need to override this method.
`boolean`	`removeListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener, I vehicleCommId)` Don't need to override this method.
`boolean`	`removeListenerFromAllSystems(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)` Removes this listener from all systems excluding the common.
`boolean`	`removeStatusListener(L listener)` This is related to the status change listeners (`statusListeners` ).
`protected void`	`sendManagerStatusChanged(int status, java.lang.String msg)` This is related to the status change listeners (`statusListeners`).
`protected void`	`sendManagerSystemAdded(I commId)` This is related to the status change listeners (`statusListeners`).
`protected void`	`sendManagerSystemRemoved(I commId)` This is related to the status change listeners (`statusListeners`).
`protected void`	`sendManagerSystemStatusChanged(I commId, int status)` This is related to the status change listeners (`statusListeners`).
`protected void`	`sendManagerVehicleAdded(VehicleType vehicle)` This is related to the status change listeners (`statusListeners`).
`protected void`	`sendManagerVehicleRemoved(VehicleType vehicle)` This is related to the status change listeners (`statusListeners`).
`void`	`sendManagerVehicleStatusChanged(VehicleType vehicle, int status)` This is related to the status change listeners (`statusListeners`).
`abstract boolean`	`sendMessage(M message, I vehicleCommId, java.lang.String sendProperties)`
`abstract boolean`	`sendMessageToVehicle(M message, java.lang.String vehicleID, java.lang.String sendProperties)` Should call `#sendMessage(MiddlewareMessage, Object)`.
`abstract boolean`	`sendMessageToVehicle(M message, VehicleType vehicle, java.lang.String sendProperties)` Should call `#sendMessage(MiddlewareMessage, Object)`.
`protected void`	`setActive(boolean isActive, Mi info, M message)` This will set activity flag and call `triggerExtraActionOnSetActive(boolean, MessageInfo, IMessage)` to trigger some extra action (by default the `triggerExtraActionOnSetActive(boolean, MessageInfo, IMessage)` does nothing).
`void`	`setArrivalDeltaTxRxTimeNanosLastMsg(double arrivalDeltaTxRxTimeNanosLastMsg)`
`protected void`	`setArrivalMessageFreq(double arrivalMessageFreq)` Don't need to override this method.
`protected void`	`setArrivalTimeMillisLastMsg(double arrivalTimeMillisLastMsg)` Don't need to override this method.
`protected void`	`setCommInfo(java.util.LinkedHashMap<I,C> commInfo)` Don't need to override this method.
`protected void`	`setMinDelay(long minDelay)` Don't need to override this method.
`protected void`	`setProcessDeltaTxRxTimeNanosLastMsg(double processDeltaTxRxTimeNanosLastMsg)`
`protected void`	`setProcessTimeMillisLastMsg(double timeMillisLastMsgReceived)` This function is used to set the last msg time arrival on processor and it will calculate the frequency of arrival.
`protected void`	`setSeqInstanceNr(long seqInstanceNr)` Don't need to override this method.
`protected void`	`setStatusListeners(java.util.LinkedHashSet<L> listeners)` This is related to the status change listeners (`statusListeners`).
`boolean`	`start()` Initialize manager.
`protected abstract boolean`	`startManagerComms()` Start the comms.
`boolean`	`stop()` Shutdown.
`protected abstract boolean`	`stopManagerComms()` Stop the comms.
`protected void`	`triggerExtraActionOnSetActive(boolean isActive, Mi info, M message)` You need to override this method to implement extra actions when `setActive(boolean, MessageInfo, IMessage)` is called.
`protected void`	`warnListeners(Mi info, M msg)` For public channel Don't need to override this method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pt.up.fe.dceg.neptus.messages.listener.MessageListener
onMessage

- Field Detail
  - statusListeners
```
protected java.util.LinkedHashSet<L extends CommManagerStatusChangeListener> statusListeners
```
  - started
```
protected boolean started
```
  - MANAGER_START
```
public static final int MANAGER_START
```
    See Also:
    
    Constant Field Values
  - MANAGER_STOP
```
public static final int MANAGER_STOP
```
    See Also:
    
    Constant Field Values
  - MANAGER_ERROR
```
public static final int MANAGER_ERROR
```
    See Also:
    
    Constant Field Values
  - SYS_COMM_ON
```
public static final int SYS_COMM_ON
```
    See Also:
    
    Constant Field Values
  - SYS_COMM_OFF
```
public static final int SYS_COMM_OFF
```
    See Also:
    
    Constant Field Values
  - SYS_NEW
```
public static final int SYS_NEW
```
    See Also:
    
    Constant Field Values
  - SYS_CTRL_CHANGED
```
public static final int SYS_CTRL_CHANGED
```
    See Also:
    
    Constant Field Values
  - timerThread
```
protected java.lang.Thread timerThread
```
  - commInfo
```
protected java.util.LinkedHashMap<I,C extends SystemCommBaseInfo<M,Mi,I>> commInfo
```
  - useListenersQueues
```
protected static boolean useListenersQueues
```
  - msgQueue
```
protected java.util.LinkedList<M extends IMessage> msgQueue
```
  - infoQueue
```
protected java.util.LinkedList<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo> infoQueue
```
  - messageProcessor
```
protected pt.up.fe.dceg.neptus.util.comm.manager.CommonCommBaseImplementation.MessageProcessor messageProcessor
```
  - isActive
```
protected boolean isActive
```
  - processTimeMillisLastMsg
```
protected double processTimeMillisLastMsg
```
  - processMsgsInLastSec
```
protected long processMsgsInLastSec
```
  - processMessageFreq
```
protected double processMessageFreq
```
  - processLastSecondMsgTime
```
protected double processLastSecondMsgTime
```
  - processDeltaTxRxTimeNanosLastMsg
```
protected double processDeltaTxRxTimeNanosLastMsg
```
  - arrivalTimeMillisLastMsg
```
protected double arrivalTimeMillisLastMsg
```
  - arrivalMsgsInLastSec
```
protected long arrivalMsgsInLastSec
```
  - arrivalMessageFreq
```
protected double arrivalMessageFreq
```
  - arrivalLastSecondMsgTime
```
protected double arrivalLastSecondMsgTime
```
  - arrivalDeltaTxRxTimeNanosLastMsg
```
protected double arrivalDeltaTxRxTimeNanosLastMsg
```
  - counter
```
protected long counter
```
  - listeners
```
protected java.util.LinkedHashSet<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,M extends IMessage>> listeners
```
  - lastListener
```
protected pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,M extends IMessage> lastListener
```
  - listenersQueueProvider
```
protected java.util.LinkedHashMap<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,M extends IMessage>,MessageListenerQueueProvider<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,M extends IMessage>> listenersQueueProvider
```
  - queueMaxSize
```
protected int queueMaxSize
```
  - seqInstanceNr
```
protected long seqInstanceNr
```
  - minDelay
```
protected long minDelay
```
    Is the separation time of each message type that is warn to the listeners. If -1 all messages are warned,
  - lastReceivedTime
```
protected java.util.LinkedHashMap<java.lang.String,java.lang.Long> lastReceivedTime
```
  - preferencesListener
```
protected PreferencesListener preferencesListener
```
- Constructor Detail
  - CommBaseManager
```
protected CommBaseManager()
```
- Method Detail
  - start
```
public boolean start()
```
    Initialize manager. Calls initManagerComms() linking the created node to #openNode and calls it's start method. Also starts messageProcessor and starts it. Then sends a MANAGER_START event. Next calls a resume message processing to each started system comms.
    This one needs to be called if you override it.
    
    Returns:
  - getTimerThread
```
public java.lang.Thread getTimerThread()
```
  - stop
```
public boolean stop()
```
    Shutdown. Stops the #openNode and messageProcessor and clears the messages queue. Calls the stopMsgProcessing on the vehicle comms. Then sends a MANAGER_STOP event.
    This one needs to be called if you override it.
    
    Returns:
  - sendManagerStatusChanged
```
protected void sendManagerStatusChanged(int status,
                                        java.lang.String msg)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    status -
    
    msg -
  - sendManagerVehicleStatusChanged
```
public void sendManagerVehicleStatusChanged(VehicleType vehicle,
                                            int status)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    vehicle -
    
    status -
  - sendManagerVehicleAdded
```
protected void sendManagerVehicleAdded(VehicleType vehicle)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    vehicle -
  - sendManagerVehicleRemoved
```
protected void sendManagerVehicleRemoved(VehicleType vehicle)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    vehicle -
  - sendManagerSystemStatusChanged
```
protected void sendManagerSystemStatusChanged(I commId,
                                              int status)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    commId -
    
    status -
  - sendManagerSystemAdded
```
protected void sendManagerSystemAdded(I commId)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    commId -
  - sendManagerSystemRemoved
```
protected void sendManagerSystemRemoved(I commId)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    commId -
  - getStatusListeners
```
protected java.util.LinkedHashSet<L> getStatusListeners()
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Returns:
    
    Returns the listeners.
  - setStatusListeners
```
protected void setStatusListeners(java.util.LinkedHashSet<L> listeners)
```
    This is related to the status change listeners (statusListeners).
    Don't need to override this method.
    
    Parameters:
    
    listeners - The listeners to set.
  - getStatusListenersSize
```
public int getStatusListenersSize()
```
    This is related to the status change listeners (statusListeners ).
    Don't need to override this method.
    
    Returns:
  - addStatusListener
```
public boolean addStatusListener(L listener)
```
    This is related to the status change listeners (statusListeners ).
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    Returns:
  - removeStatusListener
```
public boolean removeStatusListener(L listener)
```
    This is related to the status change listeners (statusListeners ).
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    Returns:
  - getStatusListenersAsHtmlFragment
```
public java.lang.String getStatusListenersAsHtmlFragment()
```
    Returns:
  - getListenersAsHtmlFragment
```
public java.lang.String getListenersAsHtmlFragment()
```
    Returns:
  - getListenersAsHtmlFragment
```
public java.lang.String getListenersAsHtmlFragment(I id)
```
    Parameters:
    
    id -
    
    Returns:
  - getCommInfoById
```
public C getCommInfoById(I id)
```
    Don't need to override this method.
    
    Parameters:
    
    id -
    
    Returns:
    
    the value to which the specified key is mapped, or null if this map contains no mapping for the key
  - getCommInfo
```
public java.util.LinkedHashMap<I,C> getCommInfo()
```
    Don't need to override this method.
    
    Returns:
    
    Returns the commInfo.
  - setCommInfo
```
protected void setCommInfo(java.util.LinkedHashMap<I,C> commInfo)
```
    Don't need to override this method.
    
    Parameters:
    
    commInfo - The commInfo to set.
  - initSystemCommInfo
```
public C initSystemCommInfo(I vIdS,
                            java.lang.String inetAddress)
```
    Initialize a vehicle comms (as in SystemCommBaseInfo).
    This function HAS TO BE overwritten (return null as the default implementation).
    This is not abstract to force "synchronized".
    
    Parameters:
    
    vIdS -
    
    inetAddress -
    
    Returns:
  - initManagerComms
```
protected abstract boolean initManagerComms()
```
    Initialize the comms. but don't start.
    
    Returns:
  - startManagerComms
```
protected abstract boolean startManagerComms()
```
    Start the comms.
    
    Returns:
  - stopManagerComms
```
protected abstract boolean stopManagerComms()
```
    Stop the comms.
    
    Returns:
  - sendMessageToVehicle
```
public abstract boolean sendMessageToVehicle(M message,
                                             VehicleType vehicle,
                                             java.lang.String sendProperties)
```
    Should call #sendMessage(MiddlewareMessage, Object).
    
    Parameters:
    
    message -
    
    vehicle -
    
    sendProperties - Properties to allow decision on how to send the message. Implementation dependent but can be a list.
    
    Returns:
  - sendMessageToVehicle
```
public abstract boolean sendMessageToVehicle(M message,
                                             java.lang.String vehicleID,
                                             java.lang.String sendProperties)
```
    Should call #sendMessage(MiddlewareMessage, Object).
    
    Parameters:
    
    message -
    
    vehicleID - This id is the vehicle id as defined by VehicleType.
    
    sendProperties - Properties to allow decision on how to send the message. Implementation dependent but can be a list.
    
    Returns:
  - sendMessage
```
public abstract boolean sendMessage(M message,
                                    I vehicleCommId,
                                    java.lang.String sendProperties)
```
    Parameters:
    
    message -
    
    vehicleCommId -
    
    sendProperties - Properties to allow decision on how to send the message. Implementation dependent but can be a list.
    
    Returns:
  - addListener
```
public boolean addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener,
                           I vehicleCommId)
```
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    vehicleCommId -
    
    Returns:
  - addListener
```
public boolean addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener,
                           I vehicleCommId,
                           MessageFilter<Mi,M> filter)
```
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    vehicleCommId -
    
    filter -
    
    Returns:
  - removeListener
```
public boolean removeListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener,
                              I vehicleCommId)
```
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    vehicleCommId -
    
    Returns:
  - removeListenerFromAllSystems
```
public final boolean removeListenerFromAllSystems(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)
```
    Removes this listener from all systems excluding the common.
    
    Parameters:
    
    listener -
    
    Returns:
  - isRunning
```
public boolean isRunning()
```
    Don't need to override this method.
    
    Returns:
  - getNumberOfSystems
```
public int getNumberOfSystems()
```
    Don't need to override this method.
    
    Returns:
  - getMsgQueueLength
```
public final int getMsgQueueLength()
```
    Don't need to override this method.
    
    Returns:
    
    The messages queue length.
  - clearMsgQueue
```
public final void clearMsgQueue()
```
    To force the clear of the messages queue.
    Don't need to override this method.
  - getListeners
```
protected final java.util.LinkedHashSet<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>> getListeners()
```
    Don't need to override this method.
    
    Returns:
    
    the listeners
  - getListenersSize
```
public final int getListenersSize()
```
    Don't need to override this method.
    
    Returns:
  - getLastListener
```
public final pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> getLastListener()
```
    Don't need to override this method.
    
    Returns:
    
    the lastListener
  - getListenersQueueProvider
```
protected final java.util.LinkedHashMap<pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>,MessageListenerQueueProvider<Mi,M>> getListenersQueueProvider()
```
    Returns:
    
    the listenersQueueProvider
  - isActive
```
public final boolean isActive()
```
    Returns:
    
    the isActive
  - setActive
```
protected final void setActive(boolean isActive,
                               Mi info,
                               M message)
```
    This will set activity flag and call triggerExtraActionOnSetActive(boolean, MessageInfo, IMessage) to trigger some extra action (by default the triggerExtraActionOnSetActive(boolean, MessageInfo, IMessage) does nothing). WARNING info and message can be null.
  - triggerExtraActionOnSetActive
```
protected void triggerExtraActionOnSetActive(boolean isActive,
                                             Mi info,
                                             M message)
```
    You need to override this method to implement extra actions when setActive(boolean, MessageInfo, IMessage) is called.
    Please don't modify the info and message and take little time on it. WARNING info and message can be null.
    
    Parameters:
    
    isActive -
    
    info - Can be null.
    
    message - Can be null.
  - getProcessTimeMillisLastMsg
```
public final double getProcessTimeMillisLastMsg()
```
    Don't need to override this method.
    
    Returns:
    
    the timeLastMsgReceived
  - setProcessTimeMillisLastMsg
```
protected final void setProcessTimeMillisLastMsg(double timeMillisLastMsgReceived)
```
    This function is used to set the last msg time arrival on processor and it will calculate the frequency of arrival.
    Don't need to override this method.
    
    Parameters:
    
    timeMillisLastMsgReceived - the timeLastMsgReceived to set
  - getProcessDeltaTxRxTimeNanosLastMsg
```
public final double getProcessDeltaTxRxTimeNanosLastMsg()
```
    Returns:
    
    the processDeltaTxRxTimeNanosLastMsg
  - setProcessDeltaTxRxTimeNanosLastMsg
```
protected final void setProcessDeltaTxRxTimeNanosLastMsg(double processDeltaTxRxTimeNanosLastMsg)
```
    Parameters:
    
    processDeltaTxRxTimeNanosLastMsg - the processDeltaTxRxTimeNanosLastMsg to set
  - getProcessMessageFreq
```
public final double getProcessMessageFreq()
```
    Don't need to override this method.
    
    Returns:
    
    the messageProcessFreq
  - getArrivalMessageFreq
```
public final double getArrivalMessageFreq()
```
    Don't need to override this method.
    
    Returns:
    
    the arrivalMessageFreq
  - setArrivalMessageFreq
```
protected final void setArrivalMessageFreq(double arrivalMessageFreq)
```
    Don't need to override this method.
    
    Parameters:
    
    arrivalMessageFreq - the arrivalMessageFreq to set
  - getArrivalTimeMillisLastMsg
```
public final double getArrivalTimeMillisLastMsg()
```
    Don't need to override this method.
    
    Returns:
    
    the arrivalTimeLastMsg
  - setArrivalTimeMillisLastMsg
```
protected final void setArrivalTimeMillisLastMsg(double arrivalTimeMillisLastMsg)
```
    Don't need to override this method.
    
    Parameters:
    
    arrivalTimeMillisLastMsg - the arrivalTimeLastMsg to set
  - getArrivalDeltaTxRxTimeNanosLastMsg
```
public final double getArrivalDeltaTxRxTimeNanosLastMsg()
```
    Returns:
    
    the arrivalDeltaTxRxTimeNanosLastMsg
  - setArrivalDeltaTxRxTimeNanosLastMsg
```
public final void setArrivalDeltaTxRxTimeNanosLastMsg(double arrivalDeltaTxRxTimeNanosLastMsg)
```
    Parameters:
    
    arrivalDeltaTxRxTimeNanosLastMsg - the arrivalDeltaTxRxTimeNanosLastMsg to set
  - getMinDelay
```
protected long getMinDelay()
```
    Don't need to override this method.
    
    Returns:
  - setMinDelay
```
protected void setMinDelay(long minDelay)
```
    Don't need to override this method.
    
    Parameters:
    
    minDelay -
  - warnListeners
```
protected void warnListeners(Mi info,
                             M msg)
```
    For public channel
    Don't need to override this method.
    
    Parameters:
    
    info -
    
    msg -
  - addListener
```
public boolean addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)
```
    For public channel
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    Returns:
  - addListener
```
public boolean addListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener,
                           MessageFilter<Mi,M> filter)
```
    Same as addListener(MessageListener) but with a filter.
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    filter - If null means no filter.
    
    Returns:
  - removeListener
```
public boolean removeListener(pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M> listener)
```
    For public channel
    Don't need to override this method.
    
    Parameters:
    
    listener -
    
    Returns:
  - onMessage
```
public final void onMessage(Mi info,
                            M msg)
```
    This is from #openNode.
    This method is to be called upon message arrival.
    
    Specified by:
    
    onMessage in interface pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,M extends IMessage>
    
    See Also:
    
    MessageListener.onMessage(pt.up.fe.dceg.neptus.messages.listener.MessageInfo, pt.up.fe.dceg.neptus.messages.IMessage)
  - processMessage
```
protected final void processMessage(Mi info,
                                    M msg)
```
    This calls:
```
 if (processMsgLocally(info, msg))
     warnListeners(info, msg);
 
```
    Normally this method is NOT needed to be overwritten.
    Parameters:
    
    info -
    
    msg -
  - processMsgLocally
```
protected abstract boolean processMsgLocally(Mi info,
                                             M msg)
```
    To be used to process the message locally.
    
    Parameters:
    
    info -
    
    msg -
    
    Returns:
    
    If the return is false the listeners are not warned.
  - getSeqInstanceNr
```
public final long getSeqInstanceNr()
```
    Don't need to override this method.
    
    Returns:
    
    the seqInstanceNr
  - setSeqInstanceNr
```
protected final void setSeqInstanceNr(long seqInstanceNr)
```
    Don't need to override this method.
    
    Parameters:
    
    seqInstanceNr - the seqInstanceNr to set
  - getNextSeqInstanceNr
```
public final long getNextSeqInstanceNr()
```
    Don't need to override this method.
    
    Returns:
    
    the next seqInstanceNr

Class CommBaseManager<M extends IMessage,Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,C extends SystemCommBaseInfo<M,Mi,I>,I,L extends CommManagerStatusChangeListener>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface pt.up.fe.dceg.neptus.messages.listener.MessageListener

Field Detail

statusListeners

started

MANAGER_START

MANAGER_STOP

MANAGER_ERROR

SYS_COMM_ON

SYS_COMM_OFF

SYS_NEW

SYS_CTRL_CHANGED

timerThread

commInfo

useListenersQueues

msgQueue

infoQueue

messageProcessor

isActive

processTimeMillisLastMsg

processMsgsInLastSec

processMessageFreq

processLastSecondMsgTime

processDeltaTxRxTimeNanosLastMsg

arrivalTimeMillisLastMsg

arrivalMsgsInLastSec

arrivalMessageFreq

arrivalLastSecondMsgTime

arrivalDeltaTxRxTimeNanosLastMsg

counter

listeners

lastListener

listenersQueueProvider

queueMaxSize

seqInstanceNr

minDelay

lastReceivedTime

preferencesListener

Constructor Detail

CommBaseManager

Method Detail

start

getTimerThread

stop

sendManagerStatusChanged

sendManagerVehicleStatusChanged

sendManagerVehicleAdded

sendManagerVehicleRemoved

sendManagerSystemStatusChanged

sendManagerSystemAdded

sendManagerSystemRemoved

getStatusListeners

setStatusListeners

getStatusListenersSize

addStatusListener

removeStatusListener

getStatusListenersAsHtmlFragment

getListenersAsHtmlFragment

getListenersAsHtmlFragment

getCommInfoById

getCommInfo

setCommInfo

initSystemCommInfo

initManagerComms

startManagerComms

stopManagerComms

sendMessageToVehicle

sendMessageToVehicle

sendMessage

addListener

addListener

removeListener

removeListenerFromAllSystems

isRunning

getNumberOfSystems

getMsgQueueLength