PartsList (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.NamedObject
- - desmoj.core.simulator.ModelComponent
  - - desmoj.extensions.applicationDomains.production.PartsList

```
public class PartsList
extends ModelComponent
```
A PartsList is a listing of all the different kinds of parts and the number (quantity) of them needed to produce a new part (or product). It is used in conjunction with a WorkStation in order to tell the work station how many and of which kind of parts should be assembled there. The user can instantiate a PartsList either by providing to arrays of the same length, one with all the different kinds of parts and one with the respective number of each different part, or by instantiating a PartsList with the number of different kinds of parts and then adding pairs of [kindOfPart, number of this kind of parts] using the addPart method.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Soenke Claassen Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors
Constructor and Description
`PartsList(Model ownerModel, java.lang.String name, java.lang.Class[] kindsOfParts, int[] numOfParts)` Constructs a PartsList with the given arrays of different kinds of parts and the quantities of that kind of part.
`PartsList(Model ownerModel, java.lang.String name, int numberOfDifferentParts)` Constructs a PartsList with enough space to store a number of different kinds of parts with the respective quantity needed of each kind.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPart(java.lang.Class kindOfPart, int numberOfParts)` Adds a pair of [kind of part, quantity of that kind of part] to the PartsList.
`int`	`getIndexOfKind(java.lang.Class kind)` Returns the index of the given kind of part ( `java.lang.Class`).
`java.lang.Class`	`getKindOfPart(int index)` Returns the kind of the part at index i as a Class object.
`java.lang.Class[]`	`getKindOfParts()` Returns the whole array of all kinds of parts listed in this PartsList.
`int`	`getNumberOfDiffParts()` Returns the number of different parts (that is the number of entries) in this PartsList.
`int[]`	`getNumberOfParts()` Returns the whole array of all the different quantities of all different kinds of parts listed in this PartsList.
`int`	`getQuantityOfPart(int index)` Returns the quantity of the part at the index i of this PartsList.

Methods inherited from class desmoj.core.simulator.ModelComponent
current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject
getName, getQuotedName, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PartsList
```
public PartsList(Model ownerModel,
                 java.lang.String name,
                 java.lang.Class[] kindsOfParts,
                 int[] numOfParts)
```
    Constructs a PartsList with the given arrays of different kinds of parts and the quantities of that kind of part. Both arrays must be of the same size, of course. The PartsList leaves no messages in the trace.
    
    Parameters:
    
    ownerModel - desmoj.Model : The model this PartsList is associated to.
    
    name - java.lang.String : The name of this PartsList.
    
    kindsOfParts - java.lang.Class[] : The array containing the different kinds of parts.
    
    numOfParts - int[] : The array constaining the number of each kind of part.
  - PartsList
```
public PartsList(Model ownerModel,
                 java.lang.String name,
                 int numberOfDifferentParts)
```
    Constructs a PartsList with enough space to store a number of different kinds of parts with the respective quantity needed of each kind. Use the method addPart to add a pair of [kind of part, quantity of that kind of part]. The PartsList leaves no messages in the trace.
    
    Parameters:
    
    ownerModel - desmoj.Model : The model this PartsList is associated to.
    
    name - java.lang.String : The name of this PartsList.
    
    numberOfDifferentParts - int : The number of different kinds of parts. Should not be zero or negative!
- Method Detail
  - addPart
```
public void addPart(java.lang.Class kindOfPart,
                    int numberOfParts)
```
    Adds a pair of [kind of part, quantity of that kind of part] to the PartsList. There can not be added more pairs than the PartsList can hold. To check how many pairs a PartList can hold use the method getNumberOfDiffParts().
    Parameters: kindOfPart - java.lang.Class : The kind of part as a Class object. numberOfParts - int : The number of that kind of part.
  getIndexOfKind public int getIndexOfKind(java.lang.Class kind) Returns the index of the given kind of part ( java.lang.Class). The index is indicating the position in the array of kindOfParts. If the given kind of part is not found in this PartsList, undefinded (-1) will be returned. Parameters: kind - java.lang.Class : The kind of part given as an object of java.lang.Class. Returns: int : The index of the given kind of part ( java.lang.Class). That is the position in the array of kindOfParts. Or undefined (-1) if no such kind of part can be found in this PartsList. getKindOfPart public java.lang.Class getKindOfPart(int index) Returns the kind of the part at index i as a Class object. Parameters: index - int : The index in the PartsList for which the kind of the part will be returned. The index runs from zero to (numberOfDiffParts - 1). Returns: java.lang.Class : The Class object identifying the kind of the part. If there is no entry at this index position in the PartsList null will be returned. getKindOfParts public java.lang.Class[] getKindOfParts() Returns the whole array of all kinds of parts listed in this PartsList. Returns: java.lang.Class[] : the whole array of all kinds of parts listed in this PartsList. getNumberOfDiffParts public int getNumberOfDiffParts() Returns the number of different parts (that is the number of entries) in this PartsList. Returns: int : The number of different parts (that is the number of entries) in this PartsList. getNumberOfParts public int[] getNumberOfParts() Returns the whole array of all the different quantities of all different kinds of parts listed in this PartsList. Returns: int[] : The whole array of all the different quantities of all different kinds of parts listed in this PartsList. getQuantityOfPart public int getQuantityOfPart(int index) Returns the quantity of the part at the index i of this PartsList. Parameters: index - int : The index in the PartsList for which the quantity of the part will be returned. The index runs from zero to (numberOfDiffParts - 1). Returns: int : The quantity of the kind of part at index i of this PartsList.

Class PartsList

Constructor Summary

Method Summary

Methods inherited from class desmoj.core.simulator.ModelComponent

Methods inherited from class desmoj.core.simulator.NamedObject

Methods inherited from class java.lang.Object

Constructor Detail

PartsList

PartsList

Method Detail

addPart

getIndexOfKind

getKindOfPart

getKindOfParts

getNumberOfDiffParts

getNumberOfParts

getQuantityOfPart