ExecutableChainImpl (SensorML Core 1.1-beta1 API)

java.lang.Object
- org.vast.sensorML.ExecutableProcessImpl
- - org.vast.sensorML.ExecutableChainImpl

All Implemented Interfaces:

Runnable, IProcessChainExec, IProcessExec
```
public class ExecutableChainImpl
extends ExecutableProcessImpl
implements IProcessChainExec
```
Implementation of an executable process chain.
This class can be associated with an AggregateProcess to provide execution capability, but this will only work if all components of the aggregate also have an executable implementation associated to them.

Since:

Feb 28, 2015

Author:

Alex Robin

Constructor Summary

Constructors
Constructor and Description

ExecutableChainImpl()

Constructors
Constructor and Description
`ExecutableChainImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`combineInputBlocks()`
`void`	`combineOutputBlocks()`
`void`	`connectInternalInput(String inputName, String dataPath, DataConnection connection)`
`void`	`connectInternalOutput(String outputName, String dataPath, DataConnection connection)`
`void`	`connectInternalParam(String paramName, String dataPath, DataConnection connection)`
`void`	`createNewOutputBlocks()` Creates new DataBlock for each output signal
`void`	`dispose()` Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...) Default method does nothing.
`void`	`execute()` Execute is typically called several times on a process and should contain all the logic to transform input/parameter values to output values.
`List<DataConnection>`	`getInternalConnections()`
`void`	`init()` Initialize the process and its internal variables (fixed parameters).
`boolean`	`isChildrenThreadsOn()`
`void`	`reset()` Resets the process (especially asnchronous ones) before it can be run again.
`void`	`setChildrenThreadsOn(boolean childrenThreadsOn)`
`void`	`setOutputNeeded(int outputIndex, boolean needed)`
`void`	`start()` Start process thread
`void`	`stop()` Stop process thread gracefully

Methods inherited from class org.vast.sensorML.ExecutableProcessImpl
canRun, connectInput, connectOutput, connectParameter, createNewInputBlocks, getInputConnections, getInputList, getName, getOutputConnections, getOutputList, getParamConnections, getParameterList, isInputConnected, isOutputConnected, isParamConnected, isUsingQueueBuffers, needSync, run, setAvailability, setUsingQueueBuffers, toString, transferData

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.vast.process.IProcessExec
canRun, connectInput, connectOutput, connectParameter, createNewInputBlocks, getInputConnections, getInputList, getName, getOutputConnections, getOutputList, getParamConnections, getParameterList, isInputConnected, isOutputConnected, isParamConnected, isUsingQueueBuffers, needSync, run, setAvailability, setUsingQueueBuffers, transferData

- Constructor Detail
  - ExecutableChainImpl
```
public ExecutableChainImpl()
```
- Method Detail
  - init
```
public void init()
          throws SMLException
```
    Description copied from interface: IProcessExec
    
    Initialize the process and its internal variables (fixed parameters). This is called only once before the process is executed.
    
    Specified by:
    
    init in interface IProcessExec
    
    Specified by:
    
    init in class ExecutableProcessImpl
    
    Throws:
    
    SMLException
  - reset
```
public void reset()
           throws SMLException
```
    Description copied from interface: IProcessExec
    
    Resets the process (especially asnchronous ones) before it can be run again. This method should properly initialize all process state variables
    
    Specified by:
    
    reset in interface IProcessExec
    
    Overrides:
    
    reset in class ExecutableProcessImpl
    
    Throws:
    
    SMLException
  - dispose
```
public void dispose()
```
    Description copied from interface: IProcessExec
    
    Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...) Default method does nothing.
    
    Specified by:
    
    dispose in interface IProcessExec
    
    Overrides:
    
    dispose in class ExecutableProcessImpl
  - execute
```
public void execute()
             throws SMLException
```
    Description copied from interface: IProcessExec
    
    Execute is typically called several times on a process and should contain all the logic to transform input/parameter values to output values. This method should be optimized as much as possible.
    
    Specified by:
    
    execute in interface IProcessExec
    
    Specified by:
    
    execute in class ExecutableProcessImpl
    
    Throws:
    
    SMLException
  - createNewOutputBlocks
```
public void createNewOutputBlocks()
```
    Description copied from interface: IProcessExec
    
    Creates new DataBlock for each output signal
    
    Specified by:
    
    createNewOutputBlocks in interface IProcessExec
    
    Overrides:
    
    createNewOutputBlocks in class ExecutableProcessImpl
  - combineInputBlocks
```
public void combineInputBlocks()
```
  - combineOutputBlocks
```
public void combineOutputBlocks()
```
  - connectInternalInput
```
public void connectInternalInput(String inputName,
                        String dataPath,
                        DataConnection connection)
                          throws SMLException
```
    Specified by:
    
    connectInternalInput in interface IProcessChainExec
    
    Throws:
    
    SMLException
  - connectInternalOutput
```
public void connectInternalOutput(String outputName,
                         String dataPath,
                         DataConnection connection)
                           throws SMLException
```
    Specified by:
    
    connectInternalOutput in interface IProcessChainExec
    
    Throws:
    
    SMLException
  - connectInternalParam
```
public void connectInternalParam(String paramName,
                        String dataPath,
                        DataConnection connection)
                          throws SMLException
```
    Specified by:
    
    connectInternalParam in interface IProcessChainExec
    
    Throws:
    
    SMLException
  - start
```
public void start()
           throws SMLException
```
    Description copied from interface: IProcessExec
    
    Start process thread
    
    Specified by:
    
    start in interface IProcessExec
    
    Overrides:
    
    start in class ExecutableProcessImpl
    
    Throws:
    
    SMLException
  - stop
```
public void stop()
```
    Description copied from interface: IProcessExec
    
    Stop process thread gracefully
    
    Specified by:
    
    stop in interface IProcessExec
    
    Overrides:
    
    stop in class ExecutableProcessImpl
  - isChildrenThreadsOn
```
public boolean isChildrenThreadsOn()
```
    Specified by:
    
    isChildrenThreadsOn in interface IProcessChainExec
  - setChildrenThreadsOn
```
public void setChildrenThreadsOn(boolean childrenThreadsOn)
```
    Specified by:
    
    setChildrenThreadsOn in interface IProcessChainExec
  - getInternalConnections
```
public List<DataConnection> getInternalConnections()
```
    Specified by:
    
    getInternalConnections in interface IProcessChainExec
  - setOutputNeeded
```
public void setOutputNeeded(int outputIndex,
                   boolean needed)
```
    Specified by:
    
    setOutputNeeded in interface IProcessChainExec

Class ExecutableChainImpl

Constructor Summary

Method Summary

Methods inherited from class org.vast.sensorML.ExecutableProcessImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.vast.process.IProcessExec

Constructor Detail

ExecutableChainImpl

Method Detail

init

reset

dispose

execute

createNewOutputBlocks

combineInputBlocks

combineOutputBlocks

connectInternalInput

connectInternalOutput

connectInternalParam

start

stop

isChildrenThreadsOn

setChildrenThreadsOn

getInternalConnections

setOutputNeeded