org.simbrain.network.update_actions

Class CustomUpdate

java.lang.Object

org.simbrain.network.update_actions.CustomUpdate

All Implemented Interfaces:

NetworkUpdateAction

public class CustomUpdate
extends java.lang.Object
implements NetworkUpdateAction

Update using a custom action saved as a beanshell script.

Author:

jyoshimi

Constructor Summary

Constructors

Constructor and Description
CustomUpdate(Network network, java.io.File file) Create a new custom update action from a file containing the custom script.
CustomUpdate(Network network, java.lang.String script) Create a new custom update action.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Provide a String description of this update method.
java.lang.String	getLongDescription() Provide a longer description for tooltips, etc.
java.lang.String	getScriptString()
void	init() Initialize the interpreter.
void	invoke() Invoke this action.
void	setScriptString(java.lang.String scriptString)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUpdate

public CustomUpdate(Network network,
                    java.lang.String script)

Create a new custom update action.

Parameters:

network - network to update

script - script to use in invoking the update action

CustomUpdate

public CustomUpdate(Network network,
                    java.io.File file)

Create a new custom update action from a file containing the custom script.

Parameters:

network - network to update

file - file containing custom code

Method Detail

init

public void init()

Initialize the interpreter.

invoke

public void invoke()

Description copied from interface: NetworkUpdateAction

Invoke this action.

Specified by:

invoke in interface NetworkUpdateAction

getDescription

public java.lang.String getDescription()

Description copied from interface: NetworkUpdateAction

Provide a String description of this update method.

Specified by:

getDescription in interface NetworkUpdateAction

Returns:

the update description

getLongDescription

public java.lang.String getLongDescription()

Description copied from interface: NetworkUpdateAction

Provide a longer description for tooltips, etc.

Specified by:

getLongDescription in interface NetworkUpdateAction

Returns:

the update description

getScriptString

public java.lang.String getScriptString()

Returns:

the scriptString

setScriptString

public void setScriptString(java.lang.String scriptString)

Parameters:

scriptString - the scriptString to set