org.imirsel.m2k.util
Class AppendMatrixStreamToSignal

java.lang.Object
  java.util.Observable
      ncsa.d2k.core.modules.RootModule
          ncsa.d2k.core.modules.ConfigurableModule
              ncsa.d2k.core.modules.EmbeddedPipeModule
                  ncsa.d2k.core.modules.ExecModule
                      ncsa.d2k.core.modules.ComputeModule
                          org.imirsel.m2k.util.AppendMatrixStreamToSignal

All Implemented Interfaces:

java.lang.Cloneable, ncsa.d2k.core.modules.Module, java.io.Serializable, ncsa.d2k.core.modules.SystemModule

public class AppendMatrixStreamToSignal

extends ncsa.d2k.core.modules.ComputeModule

This module serves as a simple API template for the coding of modules. Code comments using // are meant to serve as explanations of various elements of the API, and can be deleted. Other comments (namely those preceding java methods) are required for proper java documentation and must be filled in and modified appropriately.

Author:

Kris West

See Also:

Serialized Form

Field Summary

Fields inherited from class ncsa.d2k.core.modules.ConfigurableModule

addedInputInfo, addedInputNames, addedInputTypes, addedOutputInfo, addedOutputNames, addedOutputTypes, addPortListeners

Fields inherited from class ncsa.d2k.core.modules.RootModule

alias, children, DEBUG_LEVEL, EMPTY_INPUT, ERROR_LEVEL, executionManager, FATAL_LEVEL, HAVE_INPUT, INFO_LEVEL, iPipes, iPipesIndex, iTriggers, oPipes, oPipesIndex, oTriggers, parents, pipesFullManager, stats, triggerChildren, triggerParents, WARN_LEVEL

Fields inherited from interface ncsa.d2k.core.modules.SystemModule

BLOCKED_STATE, IDLE_STATE, MEDIUM, MEDIUM_RARE, MEDIUM_WELL, RARE, READY_STATE, WELL, WORKING_STATE

Constructor Summary

AppendMatrixStreamToSignal()

Method Summary

void	beginExecution() Performs operations at the beginning of itinerary execution.
void	doit() Appends a stream of matrices to a Signal object (number of rows is constant, cols is sum of all columns of matrix stream.
void	endExecution() Performs operations at the end of itinerary execution.
java.lang.String	getColumnNamePrefix() Returns the columnNamePrefix property, which is used to create names for each column of data by appending the column number
java.lang.String	getInputInfo(int i) Returns a text description for the indicated input.
java.lang.String	getInputName(int i) Returns a text name for the given input.
java.lang.String[]	getInputTypes() Returns an array of strings containing the Java data types of the input.
java.lang.String	getModuleInfo() Returns information about the module.
java.lang.String	getModuleName() Returns the name of the module.
java.lang.String	getOutputInfo(int i) Returns a text description for the given output.
java.lang.String	getOutputName(int i) Returns a text name for the given output.
java.lang.String[]	getOutputTypes() Returns an array of strings containing the Java data types of the outputs.
ncsa.d2k.core.modules.PropertyDescription[]	getPropertiesDescriptions() Returns an array of description objects for each property of the Module.
boolean	isReady() Returns a boolean indicating if the module is ready to execute or not.
void	setColumnNamePrefix(java.lang.String val) Sets the columnNamePrefix property, which is used to create names for each column of data by appending the column number

Methods inherited from class ncsa.d2k.core.modules.ExecModule

execute, setExecutionManager

Methods inherited from class ncsa.d2k.core.modules.ConfigurableModule

addAddPortListener, addInput, addInputTrigger, addOutput, addOutputTrigger, getAddedInputTypes, getAddedOutputTypes, getAddPortListeners, insertInput, insertOutput, removeAddPortListener, removeInput, removeInputTrigger, removeOutput, removeOutputTrigger, setAddedInputTypes, setInputType, setOutputType

Methods inherited from class ncsa.d2k.core.modules.RootModule

activateTriggers, begin, canRun, clone, debug, debug, disconnectInputPipe, disconnectInputTriggers, disconnectOutputPipe, disconnectOutputTriggers, end, error, error, fatal, fatal, fetchInputs, getAlias, getChildIndex, getChildMux, getChildren, getExecutionManager, getFile, getFlags, getFullPipeManager, getGuiComponent, getImage, getInputPipes, getInputPipeSize, getInputTriggers, getModuleStatistics, getNumInputs, getNumOutputs, getOutputCounts, getOutputPipes, getOutputPipeSize, getOutputTriggers, getParentIndex, getParentMux, getParents, getPipesFull, getPriority, getPropertyEditor, getResource, getRootName, getState, info, info, initModule, isAborting, isHead, isInputPipeConnected, isOutputPipeConnected, pullInput, pushOutput, resetInputs, setAlias, setBlocked, setD2KModulesLoggingLevel, setFlags, setFullPipeManager, setIdle, setInputPipe, setLogLevel, setModuleStatistics, setModuleStatisticsByMachine, setOutputCounts, setOutputPipe, setPipesFull, setReady, setResource, setState, setThePriority, setWorking, trigger, triggersActivated, warn, warn

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

AppendMatrixStreamToSignal

public AppendMatrixStreamToSignal()

Method Detail

getColumnNamePrefix

public java.lang.String getColumnNamePrefix()

Returns the columnNamePrefix property, which is used to create names for each column of data by appending the column number

Returns:

The columnNamePrefix

setColumnNamePrefix

public void setColumnNamePrefix(java.lang.String val)

Sets the columnNamePrefix property, which is used to create names for each column of data by appending the column number

Parameters:

val - The columnNamePrefix

getPropertiesDescriptions

public ncsa.d2k.core.modules.PropertyDescription[] getPropertiesDescriptions()

Returns an array of description objects for each property of the Module.

Returns:

an array of description objects for each property of the Module.

getModuleName

public java.lang.String getModuleName()

Returns the name of the module.

Returns:

the module name

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module.

Returns:

Module information

getInputName

public java.lang.String getInputName(int i)

Returns a text name for the given input.

Parameters:

i - the index of the input

Returns:

the name of the indexed input

getInputInfo

public java.lang.String getInputInfo(int i)

Returns a text description for the indicated input.

Parameters:

i - the index of the input

Returns:

a text description of the indexed input

getInputTypes

public java.lang.String[] getInputTypes()

Returns an array of strings containing the Java data types of the input.

Returns:

the fully qualified java types for each of the inputs

getOutputName

public java.lang.String getOutputName(int i)

Returns a text name for the given output.

Parameters:

i - the index of the output

Returns:

the name of the indexed output

getOutputInfo

public java.lang.String getOutputInfo(int i)

Returns a text description for the given output.

Parameters:

i - the index of the output

Returns:

the name of the indexed output

getOutputTypes

public java.lang.String[] getOutputTypes()

Returns an array of strings containing the Java data types of the outputs.

Returns:

the fully qualified java types for each of the outputs.

beginExecution

public void beginExecution()

Performs operations at the beginning of itinerary execution.

See Also:

endExecution()

endExecution

public void endExecution()

Performs operations at the end of itinerary execution.

See Also:

beginExecution()

isReady

public boolean isReady()

Returns a boolean indicating if the module is ready to execute or not.

Returns:

true if the module is ready to execute, false if not.

doit

public void doit()
          throws noMetadataException

Appends a stream of matrices to a Signal object (number of rows is constant, cols is sum of all columns of matrix stream.

Throws:

noMetadataException - If required metadata is not found