SystemCommBaseInfo (Neptus Package API)

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

Type Parameters:: M - extends Message; I - This represents the id for this comm.

All Implemented Interfaces:: PropertiesProvider, pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>

Direct Known Subclasses:: SystemImcMsgCommInfo

public abstract class SystemCommBaseInfo<M extends IMessage,Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,I>
extends java.lang.Object
implements pt.up.fe.dceg.neptus.messages.listener.MessageListener<Mi,M>, PropertiesProvider

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 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`
`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 java.util.LinkedHashMap<java.lang.String,com.l2fprod.common.propertysheet.DefaultProperty>`	`properties` This HashTable will hold this class properties (for the related vehicle)
`protected int`	`queueMaxSize`
`protected long`	`seqInstanceNr`
`protected I`	`systemCommId` The id used for the comm. for the vehicle.
`protected java.lang.String`	`systemIdName` As defined as the id of the `VehicleType`.
`protected static boolean`	`useListenersQueues`

Constructor Summary

Constructors
Constructor and Description

SystemCommBaseInfo()
This constructor SHOULD always be called.

Constructors
Constructor and Description
`SystemCommBaseInfo()` This constructor SHOULD always be called.

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, MessageFilter<Mi,M> filter)` Same as `addListener(MessageListener)` but with a filter.
`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.
`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.
`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.
`double`	`getProcessDeltaTxRxTimeNanosLastMsg()`
`double`	`getProcessMessageFreq()` Don't need to override this method.
`double`	`getProcessTimeMillisLastMsg()` Don't need to override this method.
`com.l2fprod.common.propertysheet.DefaultProperty[]`	`getProperties()` Don't need to override this method.
`java.lang.String`	`getPropertiesDialogTitle()` Don't need to override this method.
`java.lang.String[]`	`getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)` Don't need to override this method.
`java.lang.Object`	`getPropertyValue(java.lang.String propertyName)` Return the value of the given property name Don't need to override this method.
`long`	`getSeqInstanceNr()` Don't need to override this method.
`I`	`getSystemCommId()` Don't need to override this method.
`java.lang.String`	`getSystemIdName()` Don't need to override this method.
`protected abstract boolean`	`initSystemComms()`
`boolean`	`isActive()`
`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.
`void`	`resumeMsgProcessing()` Don't need to override this method.
`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`	`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.
`void`	`setProperties(com.l2fprod.common.propertysheet.Property[] props)` Don't need to override this method.
`void`	`setProperty(com.l2fprod.common.propertysheet.Property prop)` Add or change a property for this vehicle comm info Don't need to override this method.
`protected void`	`setSeqInstanceNr(long seqInstanceNr)` Don't need to override this method.
`void`	`setSystemCommId(I commId)` Don't need to override this method.
`void`	`setSystemIdName(java.lang.String vehicleId)` Don't need to override this method.
`protected boolean`	`start()`
`protected abstract boolean`	`startSystemComms()`
`protected boolean`	`stop()`
`void`	`stopMsgProcessing()` Don't need to override this method.
`protected abstract boolean`	`stopSystemComms()`
`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
  - systemIdName
```
protected java.lang.String systemIdName
```
    As defined as the id of the VehicleType.
  - systemCommId
```
protected I systemCommId
```
    The id used for the comm. for the vehicle.
  - properties
```
protected java.util.LinkedHashMap<java.lang.String,com.l2fprod.common.propertysheet.DefaultProperty> properties
```
    This HashTable will hold this class properties (for the related vehicle)
  - 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
  - SystemCommBaseInfo
```
public SystemCommBaseInfo()
```
    This constructor SHOULD always be called.
- Method Detail
  - stopMsgProcessing
```
public void stopMsgProcessing()
```
    Don't need to override this method.
  - resumeMsgProcessing
```
public void resumeMsgProcessing()
```
    Don't need to override this method.
  - getSystemCommId
```
public I getSystemCommId()
```
    Don't need to override this method.
    
    Returns:
    
    Returns the systemCommId.
  - setSystemCommId
```
public void setSystemCommId(I commId)
```
    Don't need to override this method.
    
    Parameters:
    
    commId - The systemCommId to set.
  - getSystemIdName
```
public java.lang.String getSystemIdName()
```
    Don't need to override this method.
    
    Returns:
    
    Returns the vehicleId as defined in VehicleType.
  - setSystemIdName
```
public void setSystemIdName(java.lang.String vehicleId)
```
    Don't need to override this method.
    
    Parameters:
    
    vehicleId - The vehicleId to set as defined in VehicleType.
  - initSystemComms
```
protected abstract boolean initSystemComms()
```
  - startSystemComms
```
protected abstract boolean startSystemComms()
```
  - stopSystemComms
```
protected abstract boolean stopSystemComms()
```
  - getProperties
```
public com.l2fprod.common.propertysheet.DefaultProperty[] getProperties()
```
    Don't need to override this method.
    The Vehicle ID, STANAG ID and LOI are regenerated.
    All other properties are taken from the properties HashTable.
    
    Specified by:
    
    getProperties in interface PropertiesProvider
  - setProperties
```
public void setProperties(com.l2fprod.common.propertysheet.Property[] props)
```
    Don't need to override this method.
    
    Specified by:
    
    setProperties in interface PropertiesProvider
    
    See Also:
    
    PropertiesProvider.setProperties(Property[])
  - setProperty
```
public void setProperty(com.l2fprod.common.propertysheet.Property prop)
```
    Add or change a property for this vehicle comm info
    Don't need to override this method.
    
    Parameters:
    
    prop - The property to be added / changed
  - getPropertyValue
```
public java.lang.Object getPropertyValue(java.lang.String propertyName)
```
    Return the value of the given property name
    Don't need to override this method.
    
    Parameters:
    
    propertyName - The name of the property
    
    Returns:
    
    The value of the given property or null if the property is not set.
  - getPropertiesDialogTitle
```
public java.lang.String getPropertiesDialogTitle()
```
    Don't need to override this method.
    
    Specified by:
    
    getPropertiesDialogTitle in interface PropertiesProvider
    
    See Also:
    
    PropertiesProvider.getPropertiesDialogTitle()
  - getPropertiesErrors
```
public java.lang.String[] getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)
```
    Don't need to override this method.
    
    Specified by:
    
    getPropertiesErrors in interface PropertiesProvider
    
    See Also:
    
    PropertiesProvider.getPropertiesErrors(Property[])
  - start
```
protected boolean start()
```
  - stop
```
protected boolean stop()
```
  - 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 SystemCommBaseInfo<M extends IMessage,Mi extends pt.up.fe.dceg.neptus.messages.listener.MessageInfo,I>

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

systemIdName

systemCommId

properties

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

SystemCommBaseInfo

Method Detail

stopMsgProcessing

resumeMsgProcessing

getSystemCommId

setSystemCommId

getSystemIdName

setSystemIdName

initSystemComms

startSystemComms

stopSystemComms

getProperties

setProperties

setProperty

getPropertyValue

getPropertiesDialogTitle

getPropertiesErrors

start

stop

getMsgQueueLength

clearMsgQueue

getListeners

getListenersSize

getLastListener

getListenersQueueProvider

isActive

setActive

triggerExtraActionOnSetActive

getProcessTimeMillisLastMsg

setProcessTimeMillisLastMsg

getProcessDeltaTxRxTimeNanosLastMsg

setProcessDeltaTxRxTimeNanosLastMsg

getProcessMessageFreq

getArrivalMessageFreq

setArrivalMessageFreq

getArrivalTimeMillisLastMsg

setArrivalTimeMillisLastMsg

getArrivalDeltaTxRxTimeNanosLastMsg

setArrivalDeltaTxRxTimeNanosLastMsg

getMinDelay

setMinDelay

warnListeners

addListener

addListener

removeListener