desmoj.core.simulator

Class InterruptCode

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.InterruptCode

public class InterruptCode
extends NamedObject

Represents a code to be passed to interrupted SimProcesses to give information about the reason for the interruption. Each new interrupt code instantiated will carry an individual internal integer codenumber to help identify different interrupt code objects. These can be checked using the static equals(InterruptCode a, InterruptCode b) method. It might come handy to clone an interrupt code object to make it known at different objects in a model. To produce a clone, create a new interrupt code using the alternative constructor method giving the interrupt code to be cloned as a parameter. That constructor will return a clone of the given interrupt code.

Version:

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

Author:

Tim Lechler 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
InterruptCode(InterruptCode cloneMe) Constructs a new interrupt code to be an identical clone of the given interrupt code object.
InterruptCode(java.lang.String name) Produces a new interrupt code with a unique internal serial number and the given name.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(InterruptCode a, InterruptCode b) Returns true if the two given interrupt codes have the same internal code, false otherwise.
int	getCodeNumber() Returns the internal unique number to identify different interrupt codes.

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

InterruptCode

public InterruptCode(InterruptCode cloneMe)

Constructs a new interrupt code to be an identical clone of the given interrupt code object. The constructor provides the new interrupt code object with same name and internal codenumber as the interrupt code object given as parameter.

Parameters:

cloneMe - desmoj.InterruptCode : The interrupt code object to produce a clone of

InterruptCode

public InterruptCode(java.lang.String name)

Produces a new interrupt code with a unique internal serial number and the given name.

Parameters:

name - java.lang.String : The interrupt code's name

Method Detail

equals

public static boolean equals(InterruptCode a,
                             InterruptCode b)

Returns true if the two given interrupt codes have the same internal code, false otherwise.

Parameters:

a - desmoj.InterruptCode : First comparand

b - desmoj.InterruptCode : Second comparand

Returns:

boolean : Is true if the two given interrupt codes have the same internal code, false otherwise

getCodeNumber

public int getCodeNumber()

Returns the internal unique number to identify different interrupt codes.

Returns:

int : The internal unique number of the interrupt code