org.eclipse.ohf.stem.definitions.labels
Interface TransportRelationshipLabel

All Superinterfaces:
DynamicEdgeLabel, DynamicLabel, EdgeLabel, org.eclipse.emf.ecore.EObject, Identifiable, Label, org.eclipse.emf.common.notify.Notifier, SanityChecker
All Known Implementing Classes:
TransportRelationshipLabelImpl

public interface TransportRelationshipLabel
extends DynamicEdgeLabel

This interface is an EMF definition of a class that represents a label for an Edge that represents the physical transportation of population members between two nodes.


Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.ohf.stem.core.graph.DynamicLabel
URI_TYPE_DYNAMIC_LABEL, URI_TYPE_DYNAMIC_LABEL_SEGMENT
 
Fields inherited from interface org.eclipse.ohf.stem.core.graph.Label
URI_TYPE_LABEL, URI_TYPE_LABEL_SEGMENT
 
Fields inherited from interface org.eclipse.ohf.stem.core.graph.Label
URI_TYPE_LABEL, URI_TYPE_LABEL_SEGMENT
 
Method Summary
 int getCapacity()
           
 TransportRelationshipLabelValue getCurrentTransportRelationshipLabelValue()
           
 int getDepartureCapacity()
           
 int getMaximumCapacity()
           
 int getMaximumDepartureCapacity()
           
 java.lang.String getPopulationIdentifier()
           
 long getRateTimePeriod()
           
 long getStartUpDelay()
           
 long getTransitTime()
           
 java.lang.String getTransportIdentifier()
           
 TransportMode getTransportMode()
           
 org.eclipse.emf.common.util.EList receive(Node here, STEMTime currentTime)
          Receive some travelers.
 void send(Node here, org.eclipse.emf.ecore.EObject departees)
          Send a representation of population members to be "transported" from the Node here to the other Node in the relationship.
 void setMaximumCapacity(int value)
          Sets the value of the 'Maximum Capacity' attribute.
 void setMaximumDepartureCapacity(int value)
          Sets the value of the 'Maximum Departure Capacity' attribute.
 void setPopulationIdentifier(java.lang.String value)
          Sets the value of the 'Population Identifier' attribute.
 void setRateTimePeriod(long value)
          Sets the value of the 'Rate Time Period' attribute.
 void setStartUpDelay(long value)
          Sets the value of the 'Start Up Delay' attribute.
 void setTransitTime(long value)
          Sets the value of the 'Transit Time' attribute.
 void setTransportIdentifier(java.lang.String value)
          Sets the value of the 'Transport Identifier' attribute.
 void setTransportMode(TransportMode value)
          Sets the value of the 'Transport Mode' attribute.
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.DynamicLabel
getDecorator, getNextValue, isNextValueValid, reset, setDecorator, setNextValue, setNextValueValid, switchToNextValue
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.Label
getCurrentValue, getIdentifiable, getURIOfIdentifiableToBeLabeled, setCurrentValue, setIdentifiable, setURIOfIdentifiableToBeLabeled
 
Methods inherited from interface org.eclipse.ohf.stem.core.common.Identifiable
getDublinCore, getTypeURI, getURI, sane, setDublinCore, setTypeURI, setURI
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.EdgeLabel
getEdge, setEdge
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.Label
getCurrentValue, getIdentifiable, getURIOfIdentifiableToBeLabeled, setCurrentValue, setIdentifiable, setURIOfIdentifiableToBeLabeled
 
Methods inherited from interface org.eclipse.ohf.stem.core.common.Identifiable
getDublinCore, getTypeURI, getURI, sane, setDublinCore, setTypeURI, setURI
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getTransportMode

TransportMode getTransportMode()

setTransportMode

void setTransportMode(TransportMode value)
Sets the value of the 'Transport Mode' attribute.

Parameters:
value - the new value of the 'Transport Mode' attribute.
See Also:
TransportMode, getTransportMode()

getPopulationIdentifier

java.lang.String getPopulationIdentifier()

setPopulationIdentifier

void setPopulationIdentifier(java.lang.String value)
Sets the value of the 'Population Identifier' attribute.

Parameters:
value - the new value of the 'Population Identifier' attribute.
See Also:
getPopulationIdentifier()

getRateTimePeriod

long getRateTimePeriod()
Returns:
the number of milliseconds it takes to transport the that defines the rate at which population members are transported. (Milliseconds)
See Also:
STEMTime

setRateTimePeriod

void setRateTimePeriod(long value)
Sets the value of the 'Rate Time Period' attribute.

Parameters:
value - the new value of the 'Rate Time Period' attribute.
See Also:
getRateTimePeriod()

getDepartureCapacity

int getDepartureCapacity()
Returns:
the current number of population members that can depart given the currently available departure capacity.
See Also:
TransportRelationshipLabelValue.getAvailableDepartureCapacityProportion(), getMaximumDepartureCapacity()

getMaximumDepartureCapacity

int getMaximumDepartureCapacity()
Returns:
the maximum number of population members that can depart using the transportation mode/identifer each time period
See Also:
#getTimePeriod(), getMaximumCapacity(), getStartUpDelay()

setMaximumDepartureCapacity

void setMaximumDepartureCapacity(int value)
Sets the value of the 'Maximum Departure Capacity' attribute.

Parameters:
value - the new value of the 'Maximum Departure Capacity' attribute.
See Also:
getMaximumDepartureCapacity()

getCapacity

int getCapacity()
Returns:
the current number of population members that can be in transit at any one time.
See Also:
TransportRelationshipLabelValue.getAvailableDepartureCapacityProportion(), getMaximumCapacity()

getMaximumCapacity

int getMaximumCapacity()
Returns:
the total maximum number of population members that can be in transit at any one time.
See Also:
#getTimePeriod(), getCapacity(), getStartUpDelay()

setMaximumCapacity

void setMaximumCapacity(int value)
Sets the value of the 'Maximum Capacity' attribute.

Parameters:
value - the new value of the 'Maximum Capacity' attribute.
See Also:
getMaximumCapacity()

getTransitTime

long getTransitTime()
Returns:
the number of milliseconds it takes population members to travel from one Node to another using the the type of transportation represented by the relationship.

setTransitTime

void setTransitTime(long value)
Sets the value of the 'Transit Time' attribute.

Parameters:
value - the new value of the 'Transit Time' attribute.
See Also:
getTransitTime()

getStartUpDelay

long getStartUpDelay()
Returns:
the number of milliseconds it takes the transportation capacity to linearly increase from zero to maximum capacity. The departure capacity also increases at this rate from 0 to its maximum.
See Also:
getMaximumCapacity(), getDepartureCapacity()

setStartUpDelay

void setStartUpDelay(long value)
Sets the value of the 'Start Up Delay' attribute.

Parameters:
value - the new value of the 'Start Up Delay' attribute.
See Also:
getStartUpDelay()

getTransportIdentifier

java.lang.String getTransportIdentifier()
Returns:
a String that identifiers the specific transportation instance. For example, this might be the name of a road.

setTransportIdentifier

void setTransportIdentifier(java.lang.String value)
Sets the value of the 'Transport Identifier' attribute.

Parameters:
value - the new value of the 'Transport Identifier' attribute.
See Also:
getTransportIdentifier()

send

void send(Node here,
          org.eclipse.emf.ecore.EObject departees)
Send a representation of population members to be "transported" from the Node here to the other Node in the relationship.

Parameters:
here - the Node the population members depart from
departees - the population member representation

receive

org.eclipse.emf.common.util.EList receive(Node here,
                                          STEMTime currentTime)
Receive some travelers.

Parameters:
here - the Node of arrival
currentTime - the current time of the simulation
Returns:
all of the representations of population members who have traveled to the Node here by the currentTime
See Also:
STEMTime

getCurrentTransportRelationshipLabelValue

TransportRelationshipLabelValue getCurrentTransportRelationshipLabelValue()
Returns:
the current transport relationship value