org.nees.rbnb.RBNBBase Class Reference

A base for RBNB Widgets. More...

Inheritance diagram for org.nees.rbnb.RBNBBase:

List of all members.

Public Member Functions
void	setBaseVarialbesFromParametes ()
	set the varables that correspond to the base parameters
void	setServerName (String name)
void	setServerPort (String port)
String	getServer ()
abstract String[]	getParameterNameArray ()
abstract String[]	getParameterTypeArray ()
abstract Object[]	getParameterDefaultArray ()
String[]	getBaseParameterNameArray ()
String[]	getBaseParameterTypeArray ()
Object[]	getBaseParameterDefaultArray ()
abstract void	setVariablesFromParameters ()
	Use the parameter table to set the actual variables for this RBNB application.
abstract boolean	start ()
	Start this instance.
abstract boolean	stop ()
	Stop this instance.
abstract boolean	isRunning ()
	Return the state of the runnning code.
Protected Member Functions
void	initialize ()
boolean	setArgs (String[] args) throws IllegalArgumentException
abstract void	setParamterArrays ()
Object	getValueWithDefault (String parameterName, Object sourceDefualt)
boolean	setBaseArgs (String[] args) throws IllegalArgumentException
abstract boolean	setInstanceArgs (String[] args) throws IllegalArgumentException
void	printUsage ()
String	getTemplateName ()
	Get the name of this widget template.
Hashtable	getParamterTable ()
void	setNewParameter (String name, String type, Object defaultValue) throws IllegalArgumentException
void	setParameterValue (String name, Object value) throws IllegalArgumentException
RBNBBaseParameterHolder	getParameter (String name)
Protected Attributes
String	dataSourceChannel = DATA_SOURCE_CHANNEL
String	dataSourceName = DATA_SOURCE_NAME
String	loggingSourceChannel = LOGGING_SOURCE_CHANNEL
String	loggindSourceName = LOGGING_SOURCE_NAME
String	commandPluginChannel = COMMAND_PLUGIN_CHANNEL
String	commandPluginName = COMMAND_PLUGIN_NAME
Static Protected Attributes
final String	DATA_SOURCE_CHANNEL = "Untyped_Unnamed_data_source"
final String	DATA_SOURCE_NAME = "data.txt"
final String	LOGGING_SOURCE_CHANNEL = "Untyped_Unnamed_debug_log_source"
final String	LOGGING_SOURCE_NAME = "log.txt"
final String	COMMAND_PLUGIN_CHANNEL = "Untyped_Unnamed_command_plugin"
final String	COMMAND_PLUGIN_NAME = "command.text"
Static Package Functions
	[static initializer]

---

Detailed Description

A base for RBNB Widgets.

Includes base parameters and constents. For actual usage this class must be extended. Specifically: the arguments must be precessed by calling the methods of the supper class; usage, and other methods need to be overwriten or extended.

Author:

Terry E Weymouth

Version:

Revision

1.10

Definition at line 30 of file RBNBBase.java.

---

Member Function Documentation

Object [] org.nees.rbnb.RBNBBase.getBaseParameterDefaultArray (   )

Returns: the array of parameter default values Definition at line 263 of file RBNBBase.java.

String [] org.nees.rbnb.RBNBBase.getBaseParameterNameArray (   )

Returns: the array of parameter names Definition at line 249 of file RBNBBase.java.

String [] org.nees.rbnb.RBNBBase.getBaseParameterTypeArray (   )

Returns: the array of parameter type Definition at line 256 of file RBNBBase.java.

abstract Object [] org.nees.rbnb.RBNBBase.getParameterDefaultArray (   )  [pure virtual]

Returns: the array of default valeus for this type of object Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

abstract String [] org.nees.rbnb.RBNBBase.getParameterNameArray (   )  [pure virtual]

Returns: the array of parameter names for this type of object Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

abstract String [] org.nees.rbnb.RBNBBase.getParameterTypeArray (   )  [pure virtual]

Returns: the array of parameter types for this type of object Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

String org.nees.rbnb.RBNBBase.getTemplateName (   )  [protected]

Get the name of this widget template. Returns: name; Definition at line 193 of file RBNBBase.java.

abstract boolean org.nees.rbnb.RBNBBase.isRunning (   )  [pure virtual]

Return the state of the runnning code. Returns: true if any of the threads in this code are running Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

void org.nees.rbnb.RBNBBase.setServerName (  String  name  )

Parameters: name  Definition at line 163 of file RBNBBase.java. References org.nees.rbnb.RBNBBase.setServerName(). Referenced by org.nees.rbnb.RBNBBase.setServerName().

void org.nees.rbnb.RBNBBase.setServerPort (  String  port  )

Parameters: port  Definition at line 171 of file RBNBBase.java. References org.nees.rbnb.RBNBBase.setServerPort(). Referenced by org.nees.rbnb.RBNBBase.setServerPort().

abstract void org.nees.rbnb.RBNBBase.setVariablesFromParameters (   )  [pure virtual]

Use the parameter table to set the actual variables for this RBNB application. Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

abstract boolean org.nees.rbnb.RBNBBase.start (   )  [pure virtual]

Start this instance. Returns: true if start was sucessful Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

abstract boolean org.nees.rbnb.RBNBBase.stop (   )  [pure virtual]

Stop this instance. Returns: true if stop was sucessful Implemented in org.nees.rbnb.AxisSource, org.nees.rbnb.DaqToRbnb, org.nees.rbnb.DataVideoGather, org.nees.rbnb.FileToRbnb, org.nees.rbnb.FlexTpsSource, org.nees.rbnb.JPEGThumbnailer, org.nees.rbnb.NumberSubSample, and org.nees.rbnb.WalkerSource.

---

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

• RBNBBase.java

---