org.simbrain.network.groups

Class Group

java.lang.Object

org.simbrain.network.groups.Group

Direct Known Subclasses:

NeuronGroup, Subnetwork, SynapseGroup

public abstract class Group
extends java.lang.Object

Group: a logical group of neurons and / or synapses. Its gui representation is GroupNode.

Constructor Summary

Constructors

Constructor and Description
Group(Network net) Construct a model group with a reference to its root network.

Method Summary

Modifier and Type	Method and Description
abstract void	delete() Perform necessary deletion cleanup.
java.lang.String	getId()
java.lang.String	getLabel()
Group	getParentGroup()
Network	getParentNetwork()
java.lang.String	getStateInfo()
abstract java.lang.String	getUpdateMethodDesecription() Returns a description of this group's update method, which is displayed in the update manager panel.
boolean	hasParentGroup() Returns true if this group has a parent group (i.e.
abstract boolean	isEmpty() Whether this group is empty or not.
boolean	isMarkedForDeletion()
boolean	isTopLevelGroup() Returns true if this group is "top level" (has no parent group).
void	recursivelySetIds() Set the id for this group.
void	setId(java.lang.String id)
void	setLabel(java.lang.String label)
protected void	setMarkedForDeletion(boolean markedForDeletion)
protected void	setParentGroup(Group parentGroup)
void	setStateInfo(java.lang.String stateInfo)
abstract int	size()
java.lang.String	toString()
abstract void	update() Update this group.

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group(Network net)

Construct a model group with a reference to its root network.

Parameters:

net - reference to root network.

Method Detail

isEmpty

public abstract boolean isEmpty()

Whether this group is empty or not.

Returns:

true if the group is empty, false otherwise.

size

public abstract int size()

Returns:

the number of synapses/neurons in this group as applicable to the group type

update

public abstract void update()

Update this group.

delete

public abstract void delete()

Perform necessary deletion cleanup.

getUpdateMethodDesecription

public abstract java.lang.String getUpdateMethodDesecription()

Returns a description of this group's update method, which is displayed in the update manager panel.

Returns:

a description of the update method.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getParentNetwork

public Network getParentNetwork()

Returns:

the parent

getId

public java.lang.String getId()

Returns:

the id

setId

public void setId(java.lang.String id)

Parameters:

id - the id to set

getLabel

public java.lang.String getLabel()

Returns:

the label

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - the label to set

getStateInfo

public java.lang.String getStateInfo()

Returns:

the stateInfo

setStateInfo

public void setStateInfo(java.lang.String stateInfo)

Parameters:

stateInfo - the stateInfo to set

getParentGroup

public Group getParentGroup()

Returns:

the parentGroup

setParentGroup

protected void setParentGroup(Group parentGroup)

Parameters:

parentGroup - the parentGroup to set

hasParentGroup

public boolean hasParentGroup()

Returns true if this group has a parent group (i.e. it is a sub-group within a larger group).

Returns:

true if this group has a parent, false otherwise.

isTopLevelGroup

public boolean isTopLevelGroup()

Returns true if this group is "top level" (has no parent group). Basically a convenience wrapper around hasParentGroup().

Returns:

true if this has a parent group, false otherwise.

isMarkedForDeletion

public boolean isMarkedForDeletion()

Returns:

the markedForDeletion

setMarkedForDeletion

protected void setMarkedForDeletion(boolean markedForDeletion)

Parameters:

markedForDeletion - the markedForDeletion to set

recursivelySetIds

public void recursivelySetIds()

Set the id for this group. A default label based on the id is also set. This is overridden by subnetowrk so that sub-groups also are given ids.