org.simbrain.workspace

Class PotentialAttribute

java.lang.Object

org.simbrain.workspace.PotentialAttribute

Direct Known Subclasses:

PotentialConsumer, PotentialProducer

public class PotentialAttribute
extends java.lang.Object

Even though a Coupling consists of a Producer and a Consumer, these attributes are usually not directly created, but are created from a PotentialProducer or PotentialConsumer object (using creation methods in AttributeManager).

Part of the reason for this is that a WorkspaceComponent needs to return a list of potential attributes that are not members of couplings, but that can be "actualized" to real attributes when creating a coupling.

PotentialAttributes contain all the same information as an attribute. For more on what these fields mean see the javadocs for Attribute

Author:

jyoshimi

See Also:

Attribute, AttributeManager, Coupling

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PotentialAttribute(WorkspaceComponent parent, java.lang.Object object, java.lang.String methodName, java.lang.Class<?> dataType, java.lang.Class<?>[] argDataTypes, java.lang.Object[] argValues, java.lang.String description) Construct a potential attribute.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>[]	getArgumentDataTypes()
java.lang.Object[]	getArgumentValues()
java.lang.Object	getBaseObject()
java.lang.Class<?>	getDataType()
java.lang.String	getDescription() Returns a description of this potential attribute; used in GUI.
java.lang.String	getMethodName()
WorkspaceComponent	getParent()
protected void	setArgumentDataTypes(java.lang.Class<?>[] argumentDataTypes)
protected void	setArgumentValues(java.lang.Object[] argumentValues)
void	setCustomDescription(java.lang.String description) Set a custom description, overriding the default description.

Methods inherited from class java.lang.Object

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

Constructor Detail

PotentialAttribute

protected PotentialAttribute(WorkspaceComponent parent,
                             java.lang.Object object,
                             java.lang.String methodName,
                             java.lang.Class<?> dataType,
                             java.lang.Class<?>[] argDataTypes,
                             java.lang.Object[] argValues,
                             java.lang.String description)

Construct a potential attribute. Should generally not be called directly. Instead the methods in AttributeManager should be called. For more on what these fields mean see the javadocs for Attribute

Parameters:

parent - parent workspace component

object - base object containing method to call

methodName - name of method to call

dataType - main data type

argDataTypes - method signature for auxiliary arguments

argValues - values for auxiliary arguments

description - description of the attribute

Method Detail

getDescription

public java.lang.String getDescription()

Returns a description of this potential attribute; used in GUI.

Returns:

a description of this attribute

getParent

public WorkspaceComponent getParent()

Returns:

the parent

getMethodName

public java.lang.String getMethodName()

Returns:

the methodName

getDataType

public java.lang.Class<?> getDataType()

Returns:

the attributeType

getBaseObject

public java.lang.Object getBaseObject()

Returns:

the object

getArgumentDataTypes

public java.lang.Class<?>[] getArgumentDataTypes()

Returns:

the argumentDataTypes

getArgumentValues

public java.lang.Object[] getArgumentValues()

Returns:

the argumentValues

setArgumentDataTypes

protected void setArgumentDataTypes(java.lang.Class<?>[] argumentDataTypes)

Parameters:

argumentDataTypes - the argumentDataTypes to set

setArgumentValues

protected void setArgumentValues(java.lang.Object[] argumentValues)

Parameters:

argumentValues - the argumentValues to set

setCustomDescription

public void setCustomDescription(java.lang.String description)

Set a custom description, overriding the default description.

Parameters:

description - the description to set