EventNote (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.EventNote

All Implemented Interfaces:

java.lang.Comparable<EventNote>
```
public class EventNote
extends java.lang.Object
implements java.lang.Comparable<EventNote>
```
Event notes contain any information needed for any type of Schedulable, event or process. Since EventNote are tightly coupled with the EventList, a change of the EventList might alo force the EventNote to contain other information especially concerning the data structures used in the EventList as well. To adopt the Event notes extend them to carry the specific data and methods you need for a possible change of the EventList. The implementation here includes data and methods for event information only, since the default implementation of class EventVector needs no special information stored inside the Event notes.

Version:

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

Author:

Tim Lechler, modified by Justin Neumann 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
`EventNote(Entity who1, Entity who2, Entity who3, EventAbstract what, TimeInstant when, int howImportant, Schedulable source)` Event notes can only be created if all relevant data can be supplied at creation time.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(EventNote note)` Compares the given EventNote to this event-note.
`EventNote`	`copy(Schedulable source)` Copies the event-note.
`boolean`	`equals(java.lang.Object object)` Returns whether this `EventNote` equals another one or not.
`Entity`	`getEntity1()` Returns the entity that is associated with this event-note.
`Entity`	`getEntity2()` Returns the entity that is associated with this event-note.
`Entity`	`getEntity3()` Returns the entity that is associated with this event-note.
`EventAbstract`	`getEvent()` Returns the event associated with this event-note.
`long`	`getNumberOfEntities()` Returns the number of included entities.
`int`	`getPriority()` Returns the priority of this event-note.
`Schedulable`	`getSource()` Returns the Schedulable that has created this event note.
`TimeInstant`	`getTime()` Returns the point of time associated with this event-note.
`int`	`hashCode()` Returns a hash code value for the object.
`java.lang.String`	`toString()` Returns a string representing the elements bundled in this event-note.

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

- Constructor Detail
  - EventNote
```
public EventNote(Entity who1,
                 Entity who2,
                 Entity who3,
                 EventAbstract what,
                 TimeInstant when,
                 int howImportant,
                 Schedulable source)
```
    Event notes can only be created if all relevant data can be supplied at creation time. Note that all relevant associations of the given Schedulables towards this event-note are built in this constructor ensuring that each scheduled Schedulable has access to its associated EventNote.
    
    Parameters:
    
    who1 - Entity : The first entity that is scheduled to be change during the course of the event or the SimProcess (or null, if such an entity is not defined)
    
    who2 - Entity : The second entity that is scheduled to be change during the course of the event or the SimProcess (or null, if such an entity is not defined)
    
    who3 - Entity : The third entity that is scheduled to be change during the course of the event or the SimProcess (or null, if such an entity is not defined)
    
    what - Event : The type of Event that scheduled to happen to the Entity or entities
    
    when - TimeInstant : The point of time that this event-note is supposed to be processed by the scheduling mechanism
    
    howImportant - int : The scheduling priority of this event note. Higher means more important.
    
    source - Schedulable : The Schedulable responsible for creating this event note
- Method Detail
  - copy
```
public EventNote copy(Schedulable source)
```
    Copies the event-note. WARNING: No additional reference is set to linked Entity.
    
    Parameters:
    
    source - Schedulable : The Schedulable responsible for copying this event note
    
    Returns:
    
    The Entity associated to this event-note
  - equals
```
public boolean equals(java.lang.Object object)
```
    Returns whether this EventNote equals another one or not.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true or false.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object. This method overrides java.lang.Object.hashCode() to support efficient treatment in HashMaps.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(EventNote note)
```
    Compares the given EventNote to this event-note. This method implements the Comparable Interface
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<EventNote>
    
    Parameters:
    
    note - The event-note to be compared to this event-note
    
    Returns:
    
    Returns a negative integer, zero, or a positive integer as this event-note is before, at the same time, or after the given EventNote.
  - getEntity1
```
public Entity getEntity1()
```
    Returns the entity that is associated with this event-note.
    
    Returns:
    
    Entity : The Entity associated to this event-note
  - getEntity2
```
public Entity getEntity2()
```
    Returns the entity that is associated with this event-note.
    
    Returns:
    
    Entity : The Entity associated to this event-note
  - getEntity3
```
public Entity getEntity3()
```
    Returns the entity that is associated with this event-note.
    
    Returns:
    
    Entity : The Entity associated to this event-note
  - getEvent
```
public EventAbstract getEvent()
```
    Returns the event associated with this event-note.
    
    Returns:
    
    Event : The event associated with this event-note
  - getNumberOfEntities
```
public long getNumberOfEntities()
```
    Returns the number of included entities.
    
    Returns:
    
    int : The number of entities
  - getTime
```
public TimeInstant getTime()
```
    Returns the point of time associated with this event-note.
    
    Returns:
    
    TimeInstant : Point of time in simulation associated with this EventNote
  - getPriority
```
public int getPriority()
```
    Returns the priority of this event-note.
    
    Returns:
    
    int : The scheduling priority of this EventNote
  - getSource
```
public Schedulable getSource()
```
    Returns the Schedulable that has created this event note.
    
    Returns:
    
    Entity : The Schedulable that has created this event note
  - toString
```
public java.lang.String toString()
```
    Returns a string representing the elements bundled in this event-note. It calls the toString() methods of every element putting each in brackets containing one or two letters to indicate the type of element.
    - En: Entity, SimProcess or null
    - Ev: Event, external event or null
    - t: simulation time
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    java.lang.String : String representing the contained elements.

Class EventNote

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventNote

Method Detail

copy

equals

hashCode

compareTo

getEntity1

getEntity2

getEntity3

getEvent

getNumberOfEntities

getTime

getPriority

getSource

toString