ModelComponent (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.NamedObject
- - desmoj.core.simulator.ModelComponent

Direct Known Subclasses:

Condition, FIFO_Transport_Strategy, FixedVCtoCBAssignment_Strategy, Gates, ModelCondition, MostFreePlaceBlockYardStrategy, PartsList, ProcessCoop, ProcessStationAnimation, ProcessStationOldAnimation, ProcessStationResAbstrAnimation, ProcessStationResNoAnimation, RandomBlockYardStrategy, Reportable, Resource, Schedulable, Track, TransportRouteAnimation, TransportStationAnimation, TransportTerminal
```
public class ModelComponent
extends NamedObject
```
Encapsulates all information relevant to each component of a model. Its basic intention is to connect each modelcomponent to a single Model object as the owner of this modelcomponent. Through this connection all relevant information about that Model can be retrieved. It is part of the composite design pattern as described in [Gamm97] page 163 in which it represents the component class.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schedulable`	`current()` Returns the currently active Schedulable object that is handled by the scheduler.
`Entity`	`currentEntity()` Returns the currently active Entity.
`java.util.List<Entity>`	`currentEntityAll()` Returns the currently active entities.
`EventAbstract`	`currentEvent()` Returns the currently active Event that is handled by the scheduler.
`Model`	`currentModel()` Returns the model that the currently active Event or Entity handled by the scheduler belongs to or the main model connected to the experiment, if no model can be returned by the scheduler.
`SimProcess`	`currentSimProcess()` Returns the currently active SimProcess that is handled by the scheduler.
`boolean`	`debugIsOn()` Shows if this modelcomponent currently produces debug output.
`void`	`debugOff()` Switches off debug output for this modelcomponent.
`void`	`debugOn()` Switches on debug output for this modelcomponent.
`Model`	`getModel()` Returns the model that owns this component.
`boolean`	`isExperimentCompatible(ModelComponent other)` Tests if the modelcomponent given as parameter is a component of the same experiment as this modelcomponent.
`boolean`	`isModelCompatible(ModelComponent other)` Tests if the modelcomponent given as parameter is a component of the same model as this modelcomponent.
`TimeInstant`	`presentTime()` Returns the current simulation time as displayed by the simulation clock responsible for this modelcomponent.
`void`	`sendDebugNote(java.lang.String description)` Creates and sends a debugnote to the experiment's messagedistributor.
`void`	`sendMessage(Message m)` Sends a message to the messagedistributor handled by the experiment.
`void`	`sendTraceNote(java.lang.String description)` Creates and sends a tracenote to the experiment's messagedistributor.
`void`	`sendWarning(java.lang.String description, java.lang.String location, java.lang.String reason, java.lang.String prevention)` Creates and sends an error message to warn about a erroneous condition in the DESMO-J framework to the experiment's messagedistributor.
`void`	`skipTraceNote()` Skips the next tracenote.
`void`	`skipTraceNote(int numSkipped)` Skips the next number of tracenotes.
`boolean`	`traceIsOn()` Shows if this modelcomponent currently produces trace output.
`void`	`traceOff()` Switches off trace output for this modelcomponent.
`void`	`traceOn()` Switches on trace output for this modelcomponent.

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
  - ModelComponent
```
public ModelComponent(Model ownerModel,
                      java.lang.String name)
```
    Constructs a modelcomponent 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:
    
    name - java.lang.String : The name of the component
    
    ownerModel - Model : The model this component is associated to.
  - ModelComponent
```
public ModelComponent(Model ownerModel,
                      java.lang.String name,
                      boolean showInTrace)
```
    Constructs a modelcomponent with the given String as name and the given model as the associated owner of this component. Components can thus only be created after the corresponding model object has been instantiated.
    
    Parameters:
    
    name - java.lang.String : The name of the component
    
    ownerModel - Model : The model this component is associated to
    
    showInTrace - boolean : Flag for showing component in trace-files. Set it to true if component should show up in trace. Set it to false if component should not be shown in trace.
- Method Detail
  - current
```
public Schedulable current()
```
    Returns the currently active Schedulable object that is handled by the scheduler.
    
    Returns:
    
    Schedulable : The current Schedulable object.
  - currentEntity
```
public Entity currentEntity()
```
    Returns the currently active Entity. Returns null if the current Schedulable happens to be an external event or a SimProcess. Note that in case the current Event refers to more than one entity (EventTwoEntitties, EventThreeEntitties), only the first entity is returned; to obtain all such entities, use getAllCurrentEntities() instead.
    
    Returns:
    
    Entity : The currently active Entity or null in case of an external event or a SimProcess being the currently active Schedulable
  - currentEntityAll
```
public java.util.List<Entity> currentEntityAll()
```
    Returns the currently active entities. Returns an empty list if the current Schedulable happens to be an external event or a SimProcess.
    
    Returns:
    
    List : A list containing the currently active entities
  - currentEvent
```
public EventAbstract currentEvent()
```
    Returns the currently active Event that is handled by the scheduler. It returns null if a process Event is the current active Schedulable, thus no Event is active.
    
    Returns:
    
    Event : The current active Event or null if the current active Schedulable is a process
  - currentModel
```
public Model currentModel()
```
    Returns the model that the currently active Event or Entity handled by the scheduler belongs to or the main model connected to the experiment, if no model can be returned by the scheduler.
    
    Returns:
    
    Model : The current active or the main model connected to the experiment, if no model can be returned by the scheduler
  - currentSimProcess
```
public SimProcess currentSimProcess()
```
    Returns the currently active SimProcess that is handled by the scheduler.
    
    Returns:
    
    SimProcess : The current active SimProcess.
  - presentTime
```
public TimeInstant presentTime()
```
    Returns the current simulation time as displayed by the simulation clock responsible for this modelcomponent.
    
    Returns:
    
    TimeInstant : The current point of simulation time
  - debugIsOn
```
public boolean debugIsOn()
```
    Shows if this modelcomponent currently produces debug output.
    
    Returns:
    
    boolean : true, if modelcomponent shows in debug, false if not
  - debugOff
```
public void debugOff()
```
    Switches off debug output for this modelcomponent. Does nothing if trace is already switched off.
  - debugOn
```
public void debugOn()
```
    Switches on debug output for this modelcomponent. Does nothing if debug is already switched on.
  - getModel
```
public Model getModel()
```
    Returns the model that owns this component.
    
    Returns:
    
    Model : The model that this component is associated to
  - isExperimentCompatible
```
public boolean isExperimentCompatible(ModelComponent other)
```
    Tests if the modelcomponent given as parameter is a component of the same experiment as this modelcomponent.
    
    Parameters:
    
    other - ModelComponent : the other modelcomponent to check compatibility with
    
    Returns:
    
    boolean : true, if this modelcomponent belongs to the same experiment as this modelcomponent, false otherwise
  - isModelCompatible
```
public boolean isModelCompatible(ModelComponent other)
```
    Tests if the modelcomponent given as parameter is a component of the same model as this modelcomponent.
    
    Parameters:
    
    other - ModelComponent : the other modelcomponent to check compatibility with
    
    Returns:
    
    boolean :true, if this modelcomponent belongs to the same model as the given modelcomponent, false otherwise
  - sendDebugNote
```
public void sendDebugNote(java.lang.String description)
```
    Creates and sends a debugnote to the experiment's messagedistributor. Debugnotes express the internal state of a modelcomponent to visualize the changes of state to help find bugs. Classes Scheduler and Queue both produce debugnotes if set to do so representing the data stored inside them. The information about the simulation time is extracted from the experiment and must not be given as a parameter.
    
    Parameters:
    
    description - java.lang.String : The description of a modelcomponent's internal state to be passed with this debugnote
  - sendMessage
```
public void sendMessage(Message m)
```
    Sends a message to the messagedistributor handled by the experiment. This modelcomponent must already be connected to an experiment in order to have a messagedistributor available to send this message to and an appropriate messagereceiver must already be registered at the messagedistributor to receive that type of message passed on to it. If no messaging subsystem is available to this modelcomponent, then the mesage is printed to the standard out printstream as configured in the local Java runtime environment of the computer this simulation is running on. Note that there are shorthands for sending the standard DESMO-J messages. These methods create and send the appropriate Message on-the-fly:
    - sendTraceNote() to send a tracenote
    Parameters: m - Message : The message to be transmitted See Also: sendTraceNote(java.lang.String), sendDebugNote(java.lang.String), sendWarning(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  sendTraceNote public void sendTraceNote(java.lang.String description) Creates and sends a tracenote to the experiment's messagedistributor. The information about the simulation time, model and component producing this tracenote is extracted from the experiment and must not be given as parameters. Parameters: description - java.lang.String : The description of the tracenote sendWarning public void sendWarning(java.lang.String description, java.lang.String location, java.lang.String reason, java.lang.String prevention) Creates and sends an error message to warn about a erroneous condition in the DESMO-J framework to the experiment's messagedistributor. Be sure to have a correct location, since the object and method that the error becomes apparent is not necessary the location it was produced in. The information about the simulation time is extracted from the Experiment and must not be given as a parameter. Parameters: description - java.lang.String : The description of the error that occured location - java.lang.String : The class and method the error occured in reason - java.lang.String : The reason most probably responsible for the error to occur prevention - java.lang.String : The measures a user should take to prevent this warning to be issued again skipTraceNote public void skipTraceNote() Skips the next tracenote. The next tracenote produced by any object in the DESMO-J framework will not be distributed by the experiment's messagemanager. This is necessary for some operations to hide the framework's actions and thus not confuse the modeller. skipTraceNote public void skipTraceNote(int numSkipped) Skips the next number of tracenotes. The next -numSkipped - number of tracenotes produced by any object in the DESMO-J framework will not be distributed by the experiment's messagemanager. This is necessary for some operations to hide the framework's actions and thus not confuse the modeller. Parameters: numSkipped - int : The number of future tracenotes to be skipped traceIsOn public boolean traceIsOn() Shows if this modelcomponent currently produces trace output. Returns: boolean : true, if modelcomponent shows in trace, false if not traceOff public void traceOff() Switches off trace output for this modelcomponent. Does nothing if trace is already switched off. traceOn public void traceOn() Switches on trace output for this modelcomponent. Does nothing if trace is already switched on.

Class ModelComponent

Constructor Summary

Method Summary

Methods inherited from class desmoj.core.simulator.NamedObject

Methods inherited from class java.lang.Object

Constructor Detail

ModelComponent

ModelComponent

Method Detail

current

currentEntity

currentEntityAll

currentEvent

currentModel

currentSimProcess

presentTime

debugIsOn

debugOff

debugOn

getModel

isExperimentCompatible

isModelCompatible

sendDebugNote

sendMessage

sendTraceNote

sendWarning

skipTraceNote

skipTraceNote

traceIsOn

traceOff

traceOn