desmoj.extensions.crossbar

Class CrossbarMessage

java.lang.Object

desmoj.core.report.Message

desmoj.extensions.crossbar.CrossbarMessage

All Implemented Interfaces:

java.lang.Cloneable

public class CrossbarMessage
extends Message
implements java.lang.Cloneable

A message which a process can send to a MessageCrossbar or a MessageChannel to activate processes waiting on the them. The CrossbarMessage contains the TimeInstant on which it was sent and its sender (the process that send the message to the crossbar).

Subclasses of the CrossbarMessage can be used to transport information between senders and receivers of messages.

Version:

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

Author:

Malte Unkrig 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.

See Also:

MessageCrossbar, MessageChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CrossbarMessage.DistributionMode The DistributionMode defines how a CrossbarMessage is distributed to receiver processes.

Constructor Summary

Constructors

Constructor and Description
CrossbarMessage(Model origin, java.lang.String description) Constructs a CrossbarMessage with the given model and description.
CrossbarMessage(Model origin, java.lang.String description, CrossbarMessage.DistributionMode distributionMode) Constructs a CrossbarMessage with the given model, description and CrossbarMessage.DistributionMode.

Method Summary

Modifier and Type	Method and Description
CrossbarMessage.DistributionMode	getDistributionMode()
SimProcess	getSender() Returns the process which sent this message to the MessageCrossbar.

Methods inherited from class desmoj.core.report.Message

getDescription, getExperimentName, getModelName, getSendTime, getTime, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossbarMessage

public CrossbarMessage(Model origin,
                       java.lang.String description)

Constructs a CrossbarMessage with the given model and description. This message will be distributed to receivers by reference. To change that specify a CrossbarMessage.DistributionMode using the constructor CrossbarMessage(Model, String, DistributionMode)

Parameters:

origin - The model the CrossbarMessage belongs to.

description - The description for the message.

CrossbarMessage

public CrossbarMessage(Model origin,
                       java.lang.String description,
                       CrossbarMessage.DistributionMode distributionMode)

Constructs a CrossbarMessage with the given model, description and CrossbarMessage.DistributionMode.

Parameters:

origin - The model the CrossbarMessage belongs to.

description - The description for the message.

distributionMode - The CrossbarMessage.DistributionMode for this message defining whether it will be distributed to receivers by reference or as a copy.

Method Detail

getDistributionMode

public CrossbarMessage.DistributionMode getDistributionMode()

Returns:

The DistributionMode of this message defining whether it will be passed to receiver processes by reference or as a copy.

getSender

public SimProcess getSender()

Returns the process which sent this message to the MessageCrossbar.

Returns:

The sender of the CrossbarMessage.