Inheritance diagram for org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >:

[legend]

Public Member Functions
StateDataComparator< TStateData >	getComparator ()
final ConnectedNode	getConnectedNode ()
GraphName	getDefaultNodeName ()
final TMessage	getNewMessageInstance ()
final TStateData	getStateData ()
void	logD (final Object message)
void	logE (final Object message)
void	logE (final Exception message)
void	logI (final Object message)
void	onError (Node node, Throwable throwable)
void	onNewMessage (TMessage message)
TConfiguration	onReconfigure (TConfiguration config, int level)
void	onShutdown (Node node)
void	onStart (final ConnectedNode connectedNode)
void	startFinal ()
final void	wakeOnLan ()
Public Attributes
TConfiguration	configuration
Static Public Attributes
static final String	PUB_STATE = "statedata"
static final String	PUB_WOL = "/wol"
static final String	SUB_CMD = "cmd_action"
static final String	SUB_STATE_ROBOT = "robotsay"
Protected Member Functions
final void	addModule (IModule< TStateData, TMessage > module)
	BaseNodeMain (String nodeName, StateDataComparator< TStateData > comparator, MessageConverter< TMessage > converter, String messageType, String stateDataType)
abstract boolean	connect ()
abstract TConfiguration	getConfig ()
NodeConfiguration	getConfiguration ()
void	initialize ()
void	initPublishers ()
void	initServices ()
void	initSubscribers ()
void	initTopics ()
final boolean	isConnected ()
void	loadParameters ()
abstract void	onConnected ()
abstract void	onDisconnected ()
void	onNewMessage (Command command)
void	refreshStateData () throws InterruptedException
Package Functions
public< T extends Message > T	getNewMessageInstance (String type)
Private Member Functions
void	publishZeroConf ()
Private Attributes
final StateDataComparator < TStateData >	comparator
ConnectedNode	connectedNode
final MessageConverter< TMessage >	converter
boolean	isConnected = false
final String	messageType
List< IModule< TStateData, TMessage > >	modules = new ArrayList<>()
final String	nodeName
TStateData	oldStateData
Publisher< TStateData >	pubStateData
Publisher< std_msgs.String >	pubWol
Server< TConfiguration >	serverReconfig
TStateData	stateData
final String	stateDataType
Thread	threadZeroconf = null

Detailed Description

Author:: Erwan Le Huitouze <erwan.lehuitouze@gmail.com>

BaseNodeMain<TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message>

Definition at line 42 of file BaseNodeMain.java.

Constructor & Destructor Documentation

org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.BaseNodeMain	(	String	nodeName,
		StateDataComparator< TStateData >	comparator,
		MessageConverter< TMessage >	converter,
		String	messageType,
		String	stateDataType
	)		`[inline, protected]`

Definition at line 76 of file BaseNodeMain.java.

Member Function Documentation

final void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.addModule ( IModule< TStateData, TMessage > module ) [inline, protected]

Definition at line 122 of file BaseNodeMain.java.

abstract boolean org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.connect ( ) [protected, pure virtual]

Connect to object

StateDataComparator<TStateData> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getComparator ( ) [inline]

Definition at line 374 of file BaseNodeMain.java.

abstract TConfiguration org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getConfig ( ) [protected, pure virtual]

NodeConfiguration org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getConfiguration ( ) [inline, protected]

Definition at line 349 of file BaseNodeMain.java.

final ConnectedNode org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getConnectedNode ( ) [inline]

Definition at line 244 of file BaseNodeMain.java.

GraphName org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getDefaultNodeName ( ) [inline]

Definition at line 249 of file BaseNodeMain.java.

final TMessage org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getNewMessageInstance ( ) [inline]

Definition at line 106 of file BaseNodeMain.java.

public<T extends Message> T org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getNewMessageInstance ( String type ) [inline, package]

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 110 of file BaseNodeMain.java.

final TStateData org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.getStateData ( ) [inline]

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 114 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.initialize ( ) [inline, protected]

On node shutdown start.

Definition at line 304 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.initPublishers ( ) [inline, protected]

Definition at line 242 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.initServices ( ) [inline, protected]

Initialize all node services.

Definition at line 239 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.initSubscribers ( ) [inline, protected]

Definition at line 241 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.initTopics ( ) [inline, protected]

Initialize all node publishers & subscribers Topics.

Definition at line 192 of file BaseNodeMain.java.

final boolean org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.isConnected ( ) [inline, protected]

Definition at line 118 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.loadParameters ( ) [inline, protected]

Load parameters of launcher

Definition at line 96 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.logD ( final Object message ) [inline]

Log a message with debug log level.

Parameters:

message this message

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 383 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.logE ( final Object message ) [inline]

Log a message with error log level.

Parameters:

message this message

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 399 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.logE ( final Exception message ) [inline]

Log a message with error log level.

Parameters:

message this message

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 407 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.logI ( final Object message ) [inline]

Log a message with info log level.

Parameters:

message this message

Implements org.rosbuilding.common.INode< TStateData >.

Definition at line 391 of file BaseNodeMain.java.

abstract void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onConnected ( ) [protected, pure virtual]

abstract void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onDisconnected ( ) [protected, pure virtual]

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onError	(	Node	node,
		Throwable	throwable
	)		`[inline]`

On node error is throw.

Definition at line 283 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onNewMessage ( TMessage message ) [inline]

On new message callback.

Parameters:

message the received media action message.

Definition at line 160 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onNewMessage ( Command command ) [inline, protected]

On new message callback.

Parameters:

command the received generic command message.

Definition at line 179 of file BaseNodeMain.java.

TConfiguration org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onReconfigure	(	TConfiguration	config,
		int	level
	)		`[inline]`

Definition at line 367 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onShutdown ( Node node ) [inline]

Definition at line 265 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.onStart ( final ConnectedNode connectedNode ) [inline]

Definition at line 254 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.publishZeroConf ( ) [inline, private]

Definition at line 326 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.refreshStateData ( ) throws InterruptedException [inline, protected]

Refresh StateData if connected object is available or try to connect it.

Exceptions:

InterruptedException

Definition at line 132 of file BaseNodeMain.java.

void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.startFinal ( ) [inline]

Definition at line 288 of file BaseNodeMain.java.

final void org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.wakeOnLan ( ) [inline]

Definition at line 318 of file BaseNodeMain.java.

Member Data Documentation

final StateDataComparator<TStateData> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.comparator [private]

Definition at line 67 of file BaseNodeMain.java.

TConfiguration org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.configuration

Definition at line 71 of file BaseNodeMain.java.

ConnectedNode org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.connectedNode [private]

Definition at line 55 of file BaseNodeMain.java.

final MessageConverter<TMessage> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.converter [private]

Definition at line 68 of file BaseNodeMain.java.

boolean org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.isConnected = false [private]

Definition at line 54 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.messageType [private]

Definition at line 69 of file BaseNodeMain.java.

List<IModule<TStateData, TMessage> > org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.modules = new ArrayList<>() [private]

Definition at line 60 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.nodeName [private]

Definition at line 72 of file BaseNodeMain.java.

TStateData org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.oldStateData [private]

Definition at line 57 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.PUB_STATE = "statedata" [static]

Definition at line 49 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.PUB_WOL = "/wol" [static]

Definition at line 48 of file BaseNodeMain.java.

Publisher<TStateData> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.pubStateData [private]

Definition at line 64 of file BaseNodeMain.java.

Publisher<std_msgs.String> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.pubWol [private]

Definition at line 65 of file BaseNodeMain.java.

Server<TConfiguration> org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.serverReconfig [private]

Definition at line 63 of file BaseNodeMain.java.

TStateData org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.stateData [private]

Definition at line 56 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.stateDataType [private]

Definition at line 70 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.SUB_CMD = "cmd_action" [static]

Definition at line 50 of file BaseNodeMain.java.

final String org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.SUB_STATE_ROBOT = "robotsay" [static]

Definition at line 51 of file BaseNodeMain.java.

Thread org.rosbuilding.common.BaseNodeMain< TConfiguration extends NodeConfig, TStateData extends Message, TMessage extends Message >.threadZeroconf = null [private]

Definition at line 74 of file BaseNodeMain.java.

The documentation for this class was generated from the following file:

BaseNodeMain.java

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Package Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation