|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectca.nengo.model.impl.PassthroughNode
public class PassthroughNode
A Node that passes values through unaltered.
This can be useful if an input to a Network is actually routed to multiple destinations, but you want to handle this connectivity within the Network rather than expose multiple terminations.
Nested Class Summary | |
---|---|
static class |
PassthroughNode.PassthroughTermination
|
Nested classes/interfaces inherited from interface ca.nengo.util.VisiblyMutable |
---|
VisiblyMutable.Event, VisiblyMutable.Listener, VisiblyMutable.NameChangeEvent, VisiblyMutable.NodeRemovedEvent |
Field Summary | |
---|---|
static java.lang.String |
ORIGIN
|
static java.lang.String |
TERMINATION
|
Constructor Summary | |
---|---|
PassthroughNode(java.lang.String name,
int dimension)
Constructor for a simple passthrough with single input. |
|
PassthroughNode(java.lang.String name,
int dimension,
java.util.Map<java.lang.String,float[][]> termDefinitions)
Constructor for a summing junction with multiple inputs. |
Method Summary | |
---|---|
void |
addChangeListener(VisiblyMutable.Listener listener)
|
Node |
clone()
|
java.lang.String |
getDocumentation()
|
SimulationMode |
getMode()
|
java.lang.String |
getName()
|
Origin |
getOrigin(java.lang.String name)
|
Origin[] |
getOrigins()
|
Termination |
getTermination(java.lang.String name)
|
Termination[] |
getTerminations()
|
void |
removeChangeListener(VisiblyMutable.Listener listener)
|
void |
reset(boolean randomize)
|
void |
run(float startTime,
float endTime)
Runs the Node (including all its components), updating internal state and outputs as needed. |
void |
setDocumentation(java.lang.String text)
|
void |
setMode(SimulationMode mode)
Does nothing (only DEFAULT mode is supported). |
void |
setName(java.lang.String name)
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TERMINATION
public static final java.lang.String ORIGIN
Constructor Detail |
---|
public PassthroughNode(java.lang.String name, int dimension)
name
- Node namedimension
- Dimension of data passing throughpublic PassthroughNode(java.lang.String name, int dimension, java.util.Map<java.lang.String,float[][]> termDefinitions)
name
- Node namedimension
- Dimension of data passing throughtermDefinitions
- Name of each Termination (TERMINATION is used for the single-input case)
and associated transformMethod Detail |
---|
public java.lang.String getName()
getName
in interface Node
Node.getName()
public void setName(java.lang.String name) throws StructuralException
setName
in interface Node
name
- The new name
StructuralException
public Origin getOrigin(java.lang.String name) throws StructuralException
getOrigin
in interface Node
name
- Name of an Origin on this Node
StructuralException
- if the named Origin does not existNode.getOrigin(java.lang.String)
public Origin[] getOrigins()
getOrigins
in interface Node
Node.getOrigins()
public Termination getTermination(java.lang.String name) throws StructuralException
getTermination
in interface Node
name
- Name of a Termination onto this Node
StructuralException
- if the named Termination does not existNode.getTermination(java.lang.String)
public Termination[] getTerminations()
getTerminations
in interface Node
Node.getTerminations()
public void run(float startTime, float endTime) throws SimulationException
Node
run
in interface Node
startTime
- simulation time at which running starts (s)endTime
- simulation time at which running ends (s)
SimulationException
- if a problem is encountered while trying to runNode.run(float, float)
public void reset(boolean randomize)
reset
in interface Resettable
randomize
- True indicates that the object should be reset to a
randomly selected initial state (the object must be aware of the
distribution from which to draw from). False indicates that the
object should be reset to a fixed initial state (which it must
also know). Some objects may not support randomization of the initial
state, in which case a fixed state will be used in either case.Resettable.reset(boolean)
public SimulationMode getMode()
getMode
in interface SimulationMode.ModeConfigurable
SimulationMode.ModeConfigurable.getMode()
public void setMode(SimulationMode mode)
setMode
in interface SimulationMode.ModeConfigurable
mode
- SimulationMode in which it is desired that the object runs.SimulationMode.ModeConfigurable.setMode(ca.nengo.model.SimulationMode)
public java.lang.String getDocumentation()
getDocumentation
in interface Node
Node.getDocumentation()
public void setDocumentation(java.lang.String text)
setDocumentation
in interface Node
text
- New user-specified documentation for the NodeNode.setDocumentation(java.lang.String)
public void addChangeListener(VisiblyMutable.Listener listener)
addChangeListener
in interface VisiblyMutable
listener
- Listener to addVisiblyMutable.addChangeListener(ca.nengo.util.VisiblyMutable.Listener)
public void removeChangeListener(VisiblyMutable.Listener listener)
removeChangeListener
in interface VisiblyMutable
listener
- Listener to removeVisiblyMutable.removeChangeListener(ca.nengo.util.VisiblyMutable.Listener)
public Node clone() throws java.lang.CloneNotSupportedException
clone
in interface Node
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |