edu.memphis.ccrg.lida.framework.shared
Interface Link

All Superinterfaces:
Activatible, Initializable, Linkable
All Known Subinterfaces:
PamLink
All Known Implementing Classes:
LinkImpl, PamLinkImpl

public interface Link
extends Linkable

A link connects two Linkable objects.

Author:
Javier Snaider, Ryan J. McCall

Field Summary
 
Fields inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD, DEFAULT_ACTIVATION
 
Method Summary
 LinkCategory getCategory()
          Get LinkCategory of this link.
 PamLink getGroundingPamLink()
          Get the grounding PamLink for this link.
 Linkable getSink()
          One end of the link which receives activation from the source.
 Node getSource()
          One end of the link which provides activation to the sink.
 boolean isSimpleLink()
          Returns whether Link is Simple (connects two nodes)
 void setCategory(LinkCategory type)
          Set LinkCategory.
 void setGroundingPamLink(PamLink l)
          Set the grounding PamLink for this link.
 void setSink(Linkable sink)
          Set sink linkable.
 void setSource(Node source)
          Set source linkable.
 void updateLinkValues(Link link)
          Subclasses of Link should override this method to set all of their type-specific member data using the values of the specified Link.
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.Linkable
getExtendedId, getFactoryType, getLabel, setFactoryType
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
decay, excite, getActivatibleRemovalThreshold, getActivation, getDecayStrategy, getExciteStrategy, getTotalActivation, isRemovable, setActivatibleRemovalThreshold, setActivation, setDecayStrategy, setExciteStrategy
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.initialization.Initializable
containsParameter, getParam, getParameters, init, init
 

Method Detail

isSimpleLink

boolean isSimpleLink()
Returns whether Link is Simple (connects two nodes)

Returns:
true if simple, false if complex (between a node and a simple link).

getSource

Node getSource()
One end of the link which provides activation to the sink.

Returns:
source linkable

getSink

Linkable getSink()
One end of the link which receives activation from the source.

Returns:
sink linkable

setSource

void setSource(Node source)
Set source linkable.

Parameters:
source - the new source

setSink

void setSink(Linkable sink)
Set sink linkable.

Parameters:
sink - the new sink

getCategory

LinkCategory getCategory()
Get LinkCategory of this link.

Returns:
the category

setCategory

void setCategory(LinkCategory type)
Set LinkCategory.

Parameters:
type - the new category

setGroundingPamLink

void setGroundingPamLink(PamLink l)
Set the grounding PamLink for this link.

Parameters:
l - the new grounding pam link

getGroundingPamLink

PamLink getGroundingPamLink()
Get the grounding PamLink for this link.

Returns:
the grounding pam link

updateLinkValues

void updateLinkValues(Link link)
Subclasses of Link should override this method to set all of their type-specific member data using the values of the specified Link. Thus specified Link must be of the same subclass type.

Parameters:
link - Link whose values are used to update with.