pt.lsts.neptus.plugins

Class MultiSystemIMCMessageListener

java.lang.Object

pt.lsts.neptus.plugins.MultiSystemIMCMessageListener

public abstract class MultiSystemIMCMessageListener
extends java.lang.Object

This Class will hook itself to the ImcMsgManager to filter messages and systems of interest controlled by setMessagesToListen(String...), setSystemToListen(ImcId16...) or setSystemToListenStrings(String...). The messageArrived(ImcId16, IMCMessage) must be implemented. You MUST call clean() in order to detach the listeners when you want to dispose of this.

Author:

Paulo Dias

Constructor Summary

Constructors

Constructor and Description
MultiSystemIMCMessageListener(java.lang.String realListenerClientStr)

Method Summary

Modifier and Type	Method and Description
void	clean() This will remove all the listeners.
java.lang.String[]	getMessagesToListen()
java.lang.String	getRealListenerClientStr()
ImcId16[]	getSystemToListen()
static void	main(java.lang.String[] args)
abstract void	messageArrived(ImcId16 id, pt.lsts.imc.IMCMessage msg) Override this in order to process the system(s) message(s).
void	setMessagesToListen(java.lang.String... messages)
void	setSystemToListen(ImcId16... ids)
void	setSystemToListenStrings(java.lang.String... idsOrNames)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MultiSystemIMCMessageListener

public MultiSystemIMCMessageListener(java.lang.String realListenerClientStr)

Parameters:

realListenerClientStr - Used in toString() just for easy debug on who's the real listener.

Method Detail

clean

public final void clean()

This will remove all the listeners. To make it working again call the setSystemToListen(ImcId16...)

getMessagesToListen

public final java.lang.String[] getMessagesToListen()

Returns:

the messagesToListen

setMessagesToListen

public final void setMessagesToListen(java.lang.String... messages)

Parameters:

messages - The list of messages to listen or empty for all.

getSystemToListen

public final ImcId16[] getSystemToListen()

setSystemToListenStrings

public final void setSystemToListenStrings(java.lang.String... idsOrNames)

Parameters:

idsOrNames - A list of String representation of IMC IDs or name IDs.

setSystemToListen

public final void setSystemToListen(ImcId16... ids)

Parameters:

ids - The ids of system to listen or empty for all systems.

messageArrived

public abstract void messageArrived(ImcId16 id,
                                    pt.lsts.imc.IMCMessage msg)

Override this in order to process the system(s) message(s).

Parameters:

id -

msg -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRealListenerClientStr

public java.lang.String getRealListenerClientStr()

Returns:

the realListenerClientStr

main

public static void main(java.lang.String[] args)