org.simbrain.util

Enum SimbrainConstants.Polarity

java.lang.Object

java.lang.Enum<SimbrainConstants.Polarity>

org.simbrain.util.SimbrainConstants.Polarity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimbrainConstants.Polarity>

Enclosing class:

SimbrainConstants

public static enum SimbrainConstants.Polarity
extends java.lang.Enum<SimbrainConstants.Polarity>

Used to indicate if an object (in particular neurons) have a polarity, i.e. are specifically excitatory or inhibitory. Convenience methods included so that values passed in respect the object's polarity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH
EXCITATORY
INHIBITORY

Method Summary

Modifier and Type	Method and Description
abstract double	clip(double val) Clips any value appropriately, e.g.
abstract java.lang.String	title() The appropriate name for the enum member, for use in the GUI.
abstract double	value(double val) Get the appropriate value, e.g.
static SimbrainConstants.Polarity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SimbrainConstants.Polarity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXCITATORY

public static final SimbrainConstants.Polarity EXCITATORY

INHIBITORY

public static final SimbrainConstants.Polarity INHIBITORY

BOTH

public static final SimbrainConstants.Polarity BOTH

Method Detail

values

public static SimbrainConstants.Polarity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SimbrainConstants.Polarity c : SimbrainConstants.Polarity.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SimbrainConstants.Polarity valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public abstract double value(double val)

Get the appropriate value, e.g. excitatory for -5 is 5.

Parameters:

val - the value to check

Returns:

the appropriate value

clip

public abstract double clip(double val)

Clips any value appropriately, e.g. excitatory for -0.1 is 0. Used to constrain the action of synaptic plasticity mechanisms.

Parameters:

val - the value to check

Returns:

a value in a range appropriate to the polarity.

title

public abstract java.lang.String title()

The appropriate name for the enum member, for use in the GUI. Mainly just capitalizes.

Returns:

the name of enum member.