desmoj.core.simulator

Class Resource

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Resource

public class Resource
extends ModelComponent

Resources are objects needed by SimProcesses to perform certain tasks. Every Resource has its unique ID number, so it can be identified. Each Resource belongs to a certain resource category (resource pool) and has the status ready (can be used) or outOfOrder if it is broken down.

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
Resource(Model ownerModel, java.lang.String name, Res resPool, boolean showInTrace) Constructs a resource object with the given String as name and the given model as the associated owner of this component.

Method Summary

Modifier and Type	Method and Description
long	getidNumber() Returns the ID number of this resource object.
Res	getResPool() Returns the resource pool (Res) this resource belongs to.
boolean	isOutOfOrder() Is this resource out of order at the moment and therefore can not be used?
void	setOutOfOrder(boolean brokenDown) This resource can be set to out of order (true) if it is broken down and can not be used at the moment.

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

Resource

public Resource(Model ownerModel,
                java.lang.String name,
                Res resPool,
                boolean showInTrace)

Constructs a resource object with the given String as name and the given model as the associated owner of this component. Components can only be created after the corresponding model object has been instantiated. The default preset for the showInTrace option is false.

Parameters:

ownerModel - Model : The model this resource is associated to.

name - java.lang.String : The name of the resource.

resPool - Res : The resource pool this resource belongs to.

showInTrace - boolean : Flag for showing this resource in trace files. Set it to true if resource should show up in trace. Set it to false if resource should not be shown in trace.

Method Detail

getidNumber

public long getidNumber()

Returns the ID number of this resource object.

Returns:

long : The ID number of this resource object.

getResPool

public Res getResPool()

Returns the resource pool (Res) this resource belongs to.

Returns:

Res : The resource pool (Res) this resource belongs to.

isOutOfOrder

public boolean isOutOfOrder()

Is this resource out of order at the moment and therefore can not be used?

Returns:

boolean : Is this resource out of order at the moment?

setOutOfOrder

public void setOutOfOrder(boolean brokenDown)

This resource can be set to out of order (true) if it is broken down and can not be used at the moment.

Parameters:

brokenDown - boolean : Flag for showing if this resource is out of order and therefore is not available at the moment. Set it to true if the resource is broken down. Set it to false if the resource is ready to use.