org.simbrain.workspace

Class Coupling<E>

java.lang.Object

org.simbrain.workspace.Coupling<E>

Type Parameters:

E - coupling attribute value type

public final class Coupling<E>
extends java.lang.Object

A coupling is an object that allows different objects in the Simbrain workspace to communicate with each other. A coupling is essentially a pair consisting of a Producer and a Consumer, where the producer passes a value of type E to the consumer:

Producer --> E --> Consumer

Producers and Consumers are types of Attribute. They are usually not created directly but are created from a PotentialAttribute. When creating couplings, a lot of the work is in creating these PotentialAttributes. Most users of the API will create Potential Attributes using the AttributeManager.

Author:

Matthew Watson, Jeff Yoshimi

See Also:

Attribute, PotentialAttribute, AttributeManager

Field Summary

Fields

Modifier and Type	Field and Description
E	buffer Value of buffer.

Constructor Summary

Constructors

Constructor and Description
Coupling(Consumer<E> Consumer) Create a coupling between a specified consuming attribute, without yet specifying the corresponding producing attribute.
Coupling(PotentialProducer producer, PotentialConsumer consumer) Create a new coupling by actualizing a potential producer and a potential consumer.
Coupling(Producer<E> Producer) Create a coupling between a specified producing attribute, without yet specifying the corresponding consuming attribute.
Coupling(Producer<E> Producer, Consumer<E> Consumer) Create a new coupling between the specified producing attribute and consuming attribute.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Consumer<E>	getConsumer()
java.lang.Class<?>	getDataType() Returns the datatype associated with this coupling.
java.lang.String	getId() Returns an id used for persistence.
Producer<E>	getProducer()
int	hashCode()
void	setBuffer() Set value of buffer.
java.lang.String	toString() Returns the string representation of this coupling.
void	update() Update this coupling.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

buffer

public E buffer

Value of buffer.

Constructor Detail

Coupling

public Coupling(Consumer<E> Consumer)

Create a coupling between a specified consuming attribute, without yet specifying the corresponding producing attribute.

Parameters:

Consumer - the attribute that consumes.

Coupling

public Coupling(Producer<E> Producer)

Create a coupling between a specified producing attribute, without yet specifying the corresponding consuming attribute.

Parameters:

Producer - the attribute that produces.

Coupling

public Coupling(Producer<E> Producer,
                Consumer<E> Consumer)

Create a new coupling between the specified producing attribute and consuming attribute.

Parameters:

Producer - producing attribute for this coupling

Consumer - consuming attribute for this coupling

Coupling

public Coupling(PotentialProducer producer,
                PotentialConsumer consumer)

Create a new coupling by actualizing a potential producer and a potential consumer.

Parameters:

producer - producing attribute for this coupling

consumer - consuming attribute for this coupling

Method Detail

setBuffer

public void setBuffer()

Set value of buffer.

update

public void update()

Update this coupling.

getProducer

public Producer<E> getProducer()

Returns:

the Producer

getConsumer

public Consumer<E> getConsumer()

Returns:

the Consumer

toString

public java.lang.String toString()

Returns the string representation of this coupling.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this coupling.

getId

public java.lang.String getId()

Returns an id used for persistence.

Returns:

id

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDataType

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

Returns the datatype associated with this coupling.

Returns:

the data type associated with this coupling.