org.hlacerti.lib

Class 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" received from HLA/CERTI. The objectInstanceID parameter give information on who is responsible of an UAV (Update Attribute Value). An UAV is an update value of a HLA attribute which belongs to a HLA class instance. 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 and Description
HlaTimedEvent(Time time, java.lang.Object obj, int hlaObjectInstanceId) Constructs a HLA event with the specified time stamp, contents and HLA object instance ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object hlaTimedEvent) Check if two HlaTimedEvent objects are equals.
int	getHlaObjectInstanceId() Return the HLA object instance ID 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 hlaObjectInstanceId)

Constructs a HLA event with the specified time stamp, contents and HLA object instance ID.

Parameters:

time - The time stamp.

obj - The contents.

hlaObjectInstanceId - The HLA object instance ID.

Method Detail

getHlaObjectInstanceId

public int getHlaObjectInstanceId()

Return the HLA object instance ID value.

Returns:

The HLA object instance ID 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.