org.simbrain.workspace

Class AttributeType

java.lang.Object

org.simbrain.workspace.AttributeType

public class AttributeType
extends java.lang.Object

Encapsulates type information about potential attribute. Used to determine which potential attributes are visible in coupling creation GUI. Displayed as typename:method<datatype>

Author:

jyoshimi

Constructor Summary

Constructors

Constructor and Description
AttributeType(WorkspaceComponent parent, java.lang.String typeName, java.lang.Class<?> dataType, boolean visible) Construct an attribute type object with no method name.
AttributeType(WorkspaceComponent parent, java.lang.String typeName, java.lang.String methodName, java.lang.Class<?> dataType, boolean visible) Construct an attribute type object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName()
java.lang.String	getBaseDescription() Returns the description string of this datatype, with a method name if there is one.
java.lang.Class	getDataType()
java.lang.String	getDescription(java.lang.String baseName) Returns a description using a custom base name (e.g.
java.lang.String	getMethodName()
WorkspaceComponent	getParentComponent()
java.lang.String	getSimpleDescription(java.lang.String baseName) Like getDescription(String) but does not add the method base name.
java.lang.String	getTypeName()
boolean	isVisible()
void	setVisible(boolean visible)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeType

public AttributeType(WorkspaceComponent parent,
                     java.lang.String typeName,
                     java.lang.String methodName,
                     java.lang.Class<?> dataType,
                     boolean visible)

Construct an attribute type object.

Parameters:

parent - reference to parent component

typeName - String identification of type id

methodName - name of method

dataType - data type (return type for producers; argument type for consumers)

visible - whether this attribute should be visible for a given component.

AttributeType

public AttributeType(WorkspaceComponent parent,
                     java.lang.String typeName,
                     java.lang.Class<?> dataType,
                     boolean visible)

Construct an attribute type object with no method name.

Parameters:

parent - reference to parent component

typeName - String identification of type id

dataType - data type (return type for producers; argument type for consumers)

visible - whether this attribute should be visible for a given component.

Method Detail

getDescription

public java.lang.String getDescription(java.lang.String baseName)

Returns a description using a custom base name (e.g. a named neuron, like "Neuron 5") as a base. Adds method base name and data type.

Parameters:

baseName - the custom base name

Returns:

the formatted string.

getSimpleDescription

public java.lang.String getSimpleDescription(java.lang.String baseName)

Like getDescription(String) but does not add the method base name.

Parameters:

baseName - the custom base name

Returns:

the formatted String

getBaseDescription

public java.lang.String getBaseDescription()

Returns the description string of this datatype, with a method name if there is one.

Returns:

the description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isVisible

public boolean isVisible()

Returns:

the visible

setVisible

public void setVisible(boolean visible)

Parameters:

visible - the visible to set

getTypeName

public java.lang.String getTypeName()

Returns:

the typeID

getAttributeName

public java.lang.String getAttributeName()

Returns:

the subtype

getDataType

public java.lang.Class getDataType()

Returns:

the dataType

getParentComponent

public WorkspaceComponent getParentComponent()

Returns:

the parentComponent

getMethodName

public java.lang.String getMethodName()

Returns:

the methodName