desmoj.core.simulator

Class NamedObject

java.lang.Object

desmoj.core.simulator.NamedObject

Direct Known Subclasses:

AbstractNumericalChartCanvas, DistributionManager, Experiment, InterruptCode, ModelComponent, ReportManager, Scheduler

public abstract class NamedObject
extends java.lang.Object

This superclass for every DESMOJ class provides the ability to carry a name for identification. Gives objects the ability to carry a name to be shown in reports. Each class in the desmoj-Framework is supposed to be able to carry a name for identification and offer methods to reset and tell its name. Since all other desmoj classes inherit from this class, it is ensured that any object, even the user's special objects, have a name to be used in a report. Offering no default constructor enforces users to give each new object in their models a name. The class is set abstract to prevent clients from accidentally creating otherwise functionless (but named) objects.

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
NamedObject(java.lang.String name) Constructs a named object with the given initial name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the named object.
java.lang.String	getQuotedName() Returns the quoted name of the named object.
java.lang.String	toString() Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedObject

public NamedObject(java.lang.String name)

Constructs a named object with the given initial name. Note, that this allows clients to produce more than one object with one name, thus being unable to distinguish those objects in reports!

Parameters:

name - java.lang.String : The given initial name for the named object

Method Detail

getName

public java.lang.String getName()

Returns the name of the named object. This is the same name displayed in reports and trace files when this named object is shown in those reports or trace files.

Returns:

java.lang.String : The name of the named object

getQuotedName

public java.lang.String getQuotedName()

Returns the quoted name of the named object. This is the name displayed in reports and trace files when this named object is shown.

Returns:

java.lang.String : The quoted name of the named object

toString

public java.lang.String toString()

Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String : The named object's name