MessageDistributor (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.report.MessageDistributor

All Implemented Interfaces:

MessageReceiver
```
public class MessageDistributor
extends java.lang.Object
implements MessageReceiver
```
The central object for distributing the messages generated by a simulation run. The MessageDistributor can receive messages and reporters and forwards them to the MessageReceiver objects registered at this MessageDistributor. When registering, the MessageReceiver has to pass a type to identify which type of messages they want to have forwarded. Note that multiple MessageReceiver s can be registered to get the same type of messages as well as a MessageReceiver can be registered with different types of messages, if it is capable of handling such. This enables a modeller i.e. to get the error messages displayed on screen additional to the file being stored on harddisk by default. This is also handy if a simulation should be run as an Applet thus having no or restricted disk access and using multiple scrollable windows instead.

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

MessageDistributor()
Constructs a new messagedistributor.

Constructors
Constructor and Description
`MessageDistributor()` Constructs a new messagedistributor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deRegister(MessageReceiver out)` De-registers the given messagereceiver from all types of Messages it was registered at.
`void`	`deRegister(MessageReceiver out, java.lang.Class<?> messageType)` De-registers a messagereceiver object to stop receiving messages of the given type.
`void`	`deRegister(MessageReceiver out, java.lang.String className)` De-registers a messagereceiver object to stop receiving messages of the given type.
`boolean`	`isOn(java.lang.Class<?> messageType)` Checks if the current messagetype is switched on to be distributed.
`boolean`	`isRegistered(java.lang.Class<?> messageType)` Checks if the given messagetype is registered at this messagedistributor.
`void`	`receive(Message m)` Receives a message and forwards it to all messagereceiver objects registered with the type of message sent.
`void`	`receive(Reporter r)` Receives a reporter and forwards it to all messagereceiver objects registered with the type of reporter sent.
`void`	`register(MessageReceiver out, java.lang.Class<?> messageType)` Registers a messagereceiver object to receive messages of the given type.
`void`	`register(MessageReceiver out, java.lang.String className)` Registers a messagereceiver object to receive messages of the given type.
`void`	`skip(java.lang.Class<?> messageType)` Skips the transmission of the next tracenote or increases the skipCounter by one.
`void`	`skip(java.lang.Class<?> messageType, int skipNumber)` Skips the transmission of a number of future messages by increasing the skipCount by the given number.
`void`	`switchOff(java.lang.Class<?> messageType)` Disables messages of the given type to be sent to the registered receivers.
`void`	`switchOn(java.lang.Class<?> messageType)` Enables messages of the given type to be sent to the registered receivers.

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

- Constructor Detail
  - MessageDistributor
```
public MessageDistributor()
```
    Constructs a new messagedistributor.
- Method Detail
  - deRegister
```
public void deRegister(MessageReceiver out)
```
    De-registers the given messagereceiver from all types of Messages it was registered at. The given messagereceiver is taken from all lists of messagereceiver.
    
    Parameters:
    
    out - MessageReceiver : The messagereceiver to be removed from all messages' lists of receivers
  - deRegister
```
public void deRegister(MessageReceiver out,
                       java.lang.Class<?> messageType)
```
    De-registers a messagereceiver object to stop receiving messages of the given type. The given messagereceiver object is taken from the list of messagereceiver receiving messages of the passed messagetype. If invalid parameters are given (i.e. null references) this method simply returns
    
    Parameters:
    
    out - MessageReceiver : The messagereceiver to be de-registered
    
    messageType - java.lang.Class : The type of messages the messagereceiver should be deregistered from
  - deRegister
```
public void deRegister(MessageReceiver out,
                       java.lang.String className)
```
    De-registers a messagereceiver object to stop receiving messages of the given type. The given messagereceiver object is taken from the list of messagereceivers receiving messages of the passed messagetype. If invalid parameters are given (i.e. null references) this method simply returns
    
    Parameters:
    
    out - MessageReceiver : The messagereceiver to be de-registered
    
    className - String : The type of messages the messagereceiver should be deregistered from
  - isOn
```
public boolean isOn(java.lang.Class<?> messageType)
```
    Checks if the current messagetype is switched on to be distributed. If not, no messages of the given type are distributed or the given type of message is not registered here.
    
    Returns:
    
    boolean : Is true if the type of message is distributed false if not or messagetype is not registered here
  - isRegistered
```
public boolean isRegistered(java.lang.Class<?> messageType)
```
    Checks if the given messagetype is registered at this messagedistributor.
    
    Returns:
    
    boolean : Is true if the messagetype is registered, false if not
  - receive
```
public void receive(Message m)
```
    Receives a message and forwards it to all messagereceiver objects registered with the type of message sent. Messages are sent, if the type of message is switched on and if the skipCounter is zero, thus not skipping any messages of that type.
    
    Specified by:
    
    receive in interface MessageReceiver
    
    Parameters:
    
    m - Message : The message to be forwarded to all registered MessageReceivers
  - receive
```
public void receive(Reporter r)
```
    Receives a reporter and forwards it to all messagereceiver objects registered with the type of reporter sent.
    
    Specified by:
    
    receive in interface MessageReceiver
    
    Parameters:
    
    r - Reporter : The reporter to be forwarded to all registered messagereceivers.
  - register
```
public void register(MessageReceiver out,
                     java.lang.Class<?> messageType)
```
    Registers a messagereceiver object to receive messages of the given type.
    
    Parameters:
    
    out - MessageReceiver : The messagereceiver to be registered
    
    messageType - java.lang.Class : The type of messages the messagereceiver is registered with
  - register
```
public void register(MessageReceiver out,
                     java.lang.String className)
```
    Registers a messagereceiver object to receive messages of the given type.
    
    Parameters:
    
    out - MessageReceiver : The messagereceiver to be registered
    
    className - java.lang.String : The name of the type of messages the messagereceiver is registered with
  - skip
```
public void skip(java.lang.Class<?> messageType)
```
    Skips the transmission of the next tracenote or increases the skipCounter by one. This is necessary to blend out any activities managed by the framework that would otherwise confuse the modeller.
  - skip
```
public void skip(java.lang.Class<?> messageType,
                 int skipNumber)
```
    Skips the transmission of a number of future messages by increasing the skipCount by the given number. This is necessary to blend out any activities managed by the framework that would otherwise confuse the modeller.
    
    Parameters:
    
    skipNumber - int : The number of messages to skip
  - switchOff
```
public void switchOff(java.lang.Class<?> messageType)
```
    Disables messages of the given type to be sent to the registered receivers.
    
    Parameters:
    
    messageType - Class : The type of messages to be switched off
  - switchOn
```
public void switchOn(java.lang.Class<?> messageType)
```
    Enables messages of the given type to be sent to the registered receivers.
    
    Parameters:
    
    messageType - Class : The type of messages to be switched on

Class MessageDistributor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageDistributor

Method Detail

deRegister

deRegister

deRegister

isOn

isRegistered

receive

receive

register

register

skip

skip

switchOff

switchOn