IProcessExec (SensorML Core 1.1-beta1 API)

All Known Subinterfaces:

IProcessChainExec

All Known Implementing Classes:

AbstractProcessImpl, AggregateProcessImpl, ExecutableChainImpl, ExecutableProcessImpl, PhysicalComponentImpl, PhysicalSystemImpl, SimpleProcessImpl
```
public interface IProcessExec
```

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canRun()` Check that all needed connections are ready for the process to run in sync mode (not threaded).
`void`	`connectInput(String inputName, String dataPath, DataConnection connection)` Connects one of this process inputs with the given connection
`void`	`connectOutput(String outputName, String dataPath, DataConnection connection)` Connects one of this process outputs with the given connection
`void`	`connectParameter(String paramName, String dataPath, DataConnection connection)` Connects one of this process parameters with the given connection
`void`	`createNewInputBlocks()` Creates new DataBlock for each input signal
`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<DataConnectionList>`	`getInputConnections()`
`IOPropertyList`	`getInputList()`
`String`	`getName()`
`List<DataConnectionList>`	`getOutputConnections()`
`IOPropertyList`	`getOutputList()`
`List<DataConnectionList>`	`getParamConnections()`
`IOPropertyList`	`getParameterList()`
`void`	`init()` Initialize the process and its internal variables (fixed parameters).
`boolean`	`isInputConnected(String inputName)` Checks if the specified input has one or more connections
`boolean`	`isOutputConnected(String outputName)` Checks if the specified output has one or more connections
`boolean`	`isParamConnected(String paramName)` Checks if the specified parameter has one or more connections
`boolean`	`isUsingQueueBuffers()` Checks if actual buffered queues are used to connect with this process
`boolean`	`needSync()`
`void`	`reset()` Resets the process (especially asnchronous ones) before it can be run again.
`void`	`run()` Process thread run method
`void`	`setAvailability(List<DataConnectionList> allConnections, boolean availability)`
`void`	`setUsingQueueBuffers(boolean usingQueueBuffers)`
`void`	`start()` Start process thread
`void`	`stop()` Stop process thread gracefully
`void`	`transferData(List<DataConnectionList> allConnections)`

- Method Detail
  - getName
```
String getName()
```
    Returns:
    process name
  - init
```
void init()
          throws SMLException
```
    Initialize the process and its internal variables (fixed parameters). This is called only once before the process is executed.
    
    Throws:
    
    SMLException
  - execute
```
void execute()
             throws SMLException
```
    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.
    
    Throws:
    
    SMLException
  - reset
```
void reset()
           throws SMLException
```
    Resets the process (especially asnchronous ones) before it can be run again. This method should properly initialize all process state variables
    
    Throws:
    
    SMLException
  - dispose
```
void dispose()
```
    Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...) Default method does nothing.
  - canRun
```
boolean canRun()
```
    Check that all needed connections are ready for the process to run in sync mode (not threaded).
    
    Returns:
    true if so and false if at least one connection is not ready.
  - createNewOutputBlocks
```
void createNewOutputBlocks()
```
    Creates new DataBlock for each output signal
  - createNewInputBlocks
```
void createNewInputBlocks()
```
    Creates new DataBlock for each input signal
  - run
```
void run()
```
    Process thread run method
  - start
```
void start()
           throws SMLException
```
    Start process thread
    
    Throws:
    
    SMLException
  - stop
```
void stop()
```
    Stop process thread gracefully
  - getInputList
```
IOPropertyList getInputList()
```
    Returns:
    list of inputs
  - getOutputList
```
IOPropertyList getOutputList()
```
    Returns:
    list of outputs
  - getParameterList
```
IOPropertyList getParameterList()
```
    Returns:
    list of parameters
  - getInputConnections
```
List<DataConnectionList> getInputConnections()
```
    Returns:
    list of input connections to read data from
  - getParamConnections
```
List<DataConnectionList> getParamConnections()
```
    Returns:
    list of parameter connections to read data from
  - getOutputConnections
```
List<DataConnectionList> getOutputConnections()
```
    Returns:
    list of output connections to write data to
  - connectInput
```
void connectInput(String inputName,
                String dataPath,
                DataConnection connection)
                  throws SMLException
```
    Connects one of this process inputs with the given connection
    
    Parameters:
    inputName - name of input to connect
    dataPath - path of component to connect
    connection - connection object whose destination will be set to the specified component
    
    Throws:
    
    SMLException
  - connectOutput
```
void connectOutput(String outputName,
                 String dataPath,
                 DataConnection connection)
                   throws SMLException
```
    Connects one of this process outputs with the given connection
    
    Parameters:
    outputName - name of output to connect
    dataPath - path of component to connect
    connection - connection object whose source will be set to the specified component
    
    Throws:
    
    SMLException
  - connectParameter
```
void connectParameter(String paramName,
                    String dataPath,
                    DataConnection connection)
                      throws SMLException
```
    Connects one of this process parameters with the given connection
    
    Parameters:
    paramName - name of parameter to connect
    dataPath - path of component to connect
    connection - connection object whose destination will be set to the specified component
    
    Throws:
    
    SMLException
  - isInputConnected
```
boolean isInputConnected(String inputName)
```
    Checks if the specified input has one or more connections
    
    Parameters:
    inputName - name of input
    
    Returns:
    true if at least one connection is made with the input
  - isOutputConnected
```
boolean isOutputConnected(String outputName)
```
    Checks if the specified output has one or more connections
    
    Parameters:
    outputName - name of output
    
    Returns:
    true if at least one connection is made with the output
  - isParamConnected
```
boolean isParamConnected(String paramName)
```
    Checks if the specified parameter has one or more connections
    
    Parameters:
    paramName - name of parameter
    
    Returns:
    true if at least one connection is made with the parameter
  - isUsingQueueBuffers
```
boolean isUsingQueueBuffers()
```
    Checks if actual buffered queues are used to connect with this process
    
    Returns:
    tru if queues are used
  - setUsingQueueBuffers
```
void setUsingQueueBuffers(boolean usingQueueBuffers)
```
  - needSync
```
boolean needSync()
```
  - setAvailability
```
void setAvailability(List<DataConnectionList> allConnections,
                   boolean availability)
```
  - transferData
```
void transferData(List<DataConnectionList> allConnections)
```

Interface IProcessExec

Method Summary

Method Detail

getName

init

execute

reset

dispose

canRun

createNewOutputBlocks

createNewInputBlocks

run

start

stop

getInputList

getOutputList

getParameterList

getInputConnections

getParamConnections

getOutputConnections

connectInput

connectOutput

connectParameter

isInputConnected

isOutputConnected

isParamConnected

isUsingQueueBuffers

setUsingQueueBuffers

needSync

setAvailability

transferData