HlaTimedEvent

java.lang.Object
- ptolemy.actor.util.TimedEvent
- - org.hlacerti.lib.HlaTimedEvent

All Implemented Interfaces:

java.lang.Comparable<TimedEvent>
```
public class HlaTimedEvent
extends TimedEvent
```
This class extends the TimedEvent class to add specific information relative to HLA "events" (also called messages) received from HLA/CERTI. The hlaInstanceHandle is a numeric handle used by the discovering federate to uniquely refer to the object instance. The existence of this object instance is informed by the callback discoverObjectInstance(className,instanceName) to the federates that subscribed to className. The updates of an attribute of the instanceName will be delivered to these federates using the callback reflectAttributeValues(). See the HlaSubscriber for its usage and more information.

Since:

Ptolemy II 11.0

Version:

$Id: HlaTimedEvent.java 151 2018-03-06 14:43:59Z gl.lasnier $

Author:

Gilles Lasnier based on OriginatedEvent.java by David Come

Pt.AcceptedRating:

Red (glasnier)

Pt.ProposedRating:

Yellow (glasnier)

Nested Class Summary
- Nested classes/interfaces inherited from class ptolemy.actor.util.TimedEvent
  TimedEvent.TimeComparator

Field Summary
- Fields inherited from class ptolemy.actor.util.TimedEvent
  contents, timeStamp

Constructor Summary

Constructors
Constructor	Description
`HlaTimedEvent(Time time, java.lang.Object obj, int hlaInstanceHandle)`	Constructs a HLA event with the specified time stamp, contents and HLA instance handle.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object hlaTimedEvent)`	Check if two HlaTimedEvent objects are equals.
`int`	`getHlaInstanceHandle()`	Return the HLA instance handle value.

Methods inherited from class ptolemy.actor.util.TimedEvent
compareTo, hashCode, toString

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

- Constructor Detail
  - HlaTimedEvent
```
public HlaTimedEvent(Time time,
                     java.lang.Object obj,
                     int hlaInstanceHandle)
```
    Constructs a HLA event with the specified time stamp, contents and HLA instance handle.
    
    Parameters:
    
    time - The time stamp.
    
    obj - The contents.
    
    hlaInstanceHandle - The HLA instance handle.
- Method Detail
  - getHlaInstanceHandle
```
public int getHlaInstanceHandle()
```
    Return the HLA instance handle value.
    
    Returns:
    
    The HLA instance handle as int.
  - equals
```
public boolean equals(java.lang.Object hlaTimedEvent)
```
    Check if two HlaTimedEvent objects are equals.
    
    Overrides:
    
    equals in class TimedEvent
    
    Parameters:
    
    hlaTimedEvent - A HlaTimedEvent object.
    
    Returns:
    
    true if the two objects are equals, false otherwise.