Class EndUnit

java.lang.Object
  |
  +--swarm.BaseImpl
        |
        +--swarm.objectbase.SwarmObjectImpl
              |
              +--EndUnit
All Implemented Interfaces:
swarm.defobj.Create, swarm.defobj.CreateS, swarm.defobj.Customize, swarm.defobj.CustomizeS, swarm.defobj.DefinedObject, swarm.defobj.DefinedObjectS, swarm.defobj.Drop, swarm.defobj.DropS, swarm.defobj.GetName, swarm.defobj.GetNameS, PTHistogramPlottable, swarm.objectbase.SwarmObject, swarm.objectbase.SwarmObjectS

public class EndUnit
extends swarm.objectbase.SwarmObjectImpl
implements PTHistogramPlottable

The EndUnit class instances represent virtual or actual places or warehouse were temporary finished sub-recipes (produced internally or obtained as procurements) wait to be used in other recipes via a "p" (procurement) step

an endUnit has its internal number equal to the concluding code used to finish/identify a temporary finished sub-recipe

Author:
Pietro Terna

Field Summary
 boolean sensitive
          declaring unit sensitive to layers
 swarm.collections.ListImpl temporaryList
          the list containing order temporary kept in this virtual (or actual) place
 swarm.collections.ArrayImpl temporaryListArray
          the array of temporary lists, if layers are > 1 and sensitive==true
 int totalLayerNumber
          the number of layers in the simulation
 int unitNumber
          the number identifying the unit which is also its end code
 
Constructor Summary
EndUnit(swarm.defobj.Zone aZone, ESFrameModelSwarm mo, int tln)
          the constructor for EndUnit
 
Method Summary
 int getAllTemporaryListCount()
          return the count of the orders in all the lists, with multiplicity
 java.lang.String getLabel()
          PTHistogramPlottable interface method: getLabel()
 int getTemporaryListCount(int cl)
          return the count of the orders in a specific list, with multiplicity
 int getUnitNumber()
          get unit number
 double getValueToPlot()
          PTHistogramPlottable interface method: getValueToPlot()
 java.lang.Object removeFromTemporaryList(int cl)
          Removing an order from the temporaryList of the unit and returning its address of the order or of its clone if the original order has multiplicity > 1
 void setNotSensitiveToLayers()
          declaring the end unit insensitive to layers (its number is reported as negative in unitData/endUnitList.txt)
 void setTemporaryList(Order anOrder)
          Putting an order in the temporaryList of the unit, in a given layer
 void setUnitNumber(int un)
          set unit number
 
Methods inherited from class swarm.objectbase.SwarmObjectImpl
compare, describe, describeID, drop, getCompleteProbeMap, getDisplayName, getName, getProbeForMessage, getProbeForVariable, getProbeMap, getTypeName, getZone, perform, perform$with, perform$with$with, perform$with$with$with, respondsTo, setDisplayName, xfprint, xfprintid, xprint, xprintid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

unitNumber

public int unitNumber
the number identifying the unit which is also its end code


totalLayerNumber

public int totalLayerNumber
the number of layers in the simulation


sensitive

public boolean sensitive
declaring unit sensitive to layers


temporaryListArray

public swarm.collections.ArrayImpl temporaryListArray
the array of temporary lists, if layers are > 1 and sensitive==true


temporaryList

public swarm.collections.ListImpl temporaryList
the list containing order temporary kept in this virtual (or actual) place

Constructor Detail

EndUnit

public EndUnit(swarm.defobj.Zone aZone,
               ESFrameModelSwarm mo,
               int tln)
the constructor for EndUnit

Method Detail

setUnitNumber

public void setUnitNumber(int un)
set unit number


getUnitNumber

public int getUnitNumber()
get unit number


setTemporaryList

public void setTemporaryList(Order anOrder)
Putting an order in the temporaryList of the unit, in a given layer


removeFromTemporaryList

public java.lang.Object removeFromTemporaryList(int cl)
Removing an order from the temporaryList of the unit and returning its address of the order or of its clone if the original order has multiplicity > 1


getAllTemporaryListCount

public int getAllTemporaryListCount()
return the count of the orders in all the lists, with multiplicity


getTemporaryListCount

public int getTemporaryListCount(int cl)
return the count of the orders in a specific list, with multiplicity


setNotSensitiveToLayers

public void setNotSensitiveToLayers()
declaring the end unit insensitive to layers (its number is reported as negative in unitData/endUnitList.txt)


getLabel

public java.lang.String getLabel()
PTHistogramPlottable interface method: getLabel()

Specified by:
getLabel in interface PTHistogramPlottable

getValueToPlot

public double getValueToPlot()
PTHistogramPlottable interface method: getValueToPlot()

Specified by:
getValueToPlot in interface PTHistogramPlottable