ctu.nengoros.comm.rosBackend.encoders.multiTermination

Interface MultiTermination

All Superinterfaces:

java.lang.Cloneable, Resettable, java.io.Serializable

All Known Implementing Classes:

AbstractMultiTermination, BasicMultiTermination, SumMultiTermination

public interface MultiTermination
extends java.io.Serializable, Resettable, java.lang.Cloneable

This is as similar as possible to the Termination. The main difference is that this holds multiple terminations for one Node and represents one Nodes "input".

Run of the MultiTermination is composed of two steps: run all its Terminations and sum all values on these terminations. The entire process should be transparent to the Nengo except the fact that the particular Node is responsible for running own MultiTerminations and read their values

Method Summary

Methods

Modifier and Type	Method and Description
Termination	addTermination() Add new weighted termination with the default weight (1).
Termination	addTermination(float weight) Specify the weight of this newly created Termination, if the Terminaion is multi-dimensional, weight will be applied on all dimensions.
Termination	addTermination(java.lang.Float[] weights) Specify the weight matrix for this newly created weighted Termination.
int	getDimension() NUmber of values passed through multiTerminations, the same as dimensions of all child Terminations.
java.lang.String	getName()
Node	getNode() Get parent Node of my all Terminations.
TimeSeries	getOutput() Get output of this MultiTermination
java.util.HashMap<java.lang.String,Termination>	getTerminations()
void	run(float startTime, float endTime) This supposed that all my Terminations were ran before, so this method just combines values on them to one own value.

Methods inherited from interface ca.nengo.model.Resettable

reset

Method Detail

getName

java.lang.String getName()

addTermination

Termination addTermination()
                           throws StructuralException

Add new weighted termination with the default weight (1). The Terminations are named as follows: first Termination is created automatically and corresponds with the name of MultiTermination (backwards compatibility). Following added Terminations are named as follows: "[MultiTermination_name]_0", "[MultiTermination_name]_1", ...

Returns:

new Termination with auto-generated name

Throws:

StructuralException

addTermination

Termination addTermination(float weight)
                           throws StructuralException

Specify the weight of this newly created Termination, if the Terminaion is multi-dimensional, weight will be applied on all dimensions.

Parameters:

weight - the termination can be weighter

Returns:

new weighted Termination with auto-generated name

Throws:

StructuralException

addTermination

Termination addTermination(java.lang.Float[] weights)
                           throws StructuralException

Specify the weight matrix for this newly created weighted Termination.

Parameters:

weights - weight matrix

Returns:

new weighted Termination with auto-generated name

Throws:

StructuralException

getTerminations

java.util.HashMap<java.lang.String,Termination> getTerminations()

run

void run(float startTime,
       float endTime)
         throws SimulationException

This supposed that all my Terminations were ran before, so this method just combines values on them to one own value. This method sets the value of TimeSeries myOutput, which can be obtained by means of getOutput() method after that.

Parameters:

startTime - simulation time at which running starts (s)

endTime - simulation time at which running ends (s)

Throws:

SimulationException - if a problem is encountered while trying to run

getOutput

TimeSeries getOutput()

Get output of this MultiTermination

Returns:

TimeSeries representing the actual output

getNode

Node getNode()

Get parent Node of my all Terminations.

Returns:

getDimension

int getDimension()

NUmber of values passed through multiTerminations, the same as dimensions of all child Terminations.

Returns:

dimensionality of the multi-termination