org.trianacode.taskgraph.event

Class TaskGraphCableEvent

java.lang.Object

java.util.EventObject

org.trianacode.taskgraph.event.TaskGraphCableEvent

All Implemented Interfaces:

java.io.Serializable

public class TaskGraphCableEvent
extends java.util.EventObject

The event generated when a cable is connected/disconnected within a taskgraph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CABLE_CONNECTED
static int	CABLE_DISCONNECTED
static int	CABLE_RECONNECTED_INPUT
static int	CABLE_RECONNECTED_OUTPUT
static int	GROUP_EVENT
static int	NON_GROUP_EVENT
static int	UNGROUP_EVENT

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TaskGraphCableEvent(int id, TaskGraph taskgraph, Cable cable, int groupevent) Constructs a task graph cable event
TaskGraphCableEvent(int id, TaskGraph taskgraph, java.lang.String sendid, int sendnode, java.lang.String recid, int recnode, int groupevent) Constructs a task graph cable event

Method Summary

Methods

Modifier and Type	Method and Description
Cable	getCable()
int	getGroupEventID()
int	getID()
int	getReceivingNodeIndex()
java.lang.String	getReceivingTaskID()
int	getSendingNodeIndex()
java.lang.String	getSendingTaskID()
TaskGraph	getTaskGraph()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CABLE_CONNECTED

public static final int CABLE_CONNECTED

See Also:

Constant Field Values

CABLE_RECONNECTED_INPUT

public static final int CABLE_RECONNECTED_INPUT

See Also:

Constant Field Values

CABLE_RECONNECTED_OUTPUT

public static final int CABLE_RECONNECTED_OUTPUT

See Also:

Constant Field Values

CABLE_DISCONNECTED

public static final int CABLE_DISCONNECTED

See Also:

Constant Field Values

NON_GROUP_EVENT

public static final int NON_GROUP_EVENT

See Also:

Constant Field Values

GROUP_EVENT

public static final int GROUP_EVENT

See Also:

Constant Field Values

UNGROUP_EVENT

public static final int UNGROUP_EVENT

See Also:

Constant Field Values

Constructor Detail

TaskGraphCableEvent

public TaskGraphCableEvent(int id,
                   TaskGraph taskgraph,
                   Cable cable,
                   int groupevent)

Constructs a task graph cable event

Parameters:

id - the id of this event (either CABLE_CONNECTED, CABLE_RECONNECTED_INPUT, CABLE_RECONNECTED_OUTPUT or CABLE_DISCONNECTED)

taskgraph - the source of the task graph event

cable - the cable being connected/disconnected

TaskGraphCableEvent

public TaskGraphCableEvent(int id,
                   TaskGraph taskgraph,
                   java.lang.String sendid,
                   int sendnode,
                   java.lang.String recid,
                   int recnode,
                   int groupevent)

Constructs a task graph cable event

Parameters:

id - the id of this event (either CABLE_CONNECTED, CABLE_RECONNECTED_INPUT, CABLE_RECONNECTED_OUTPUT or CABLE_DISCONNECTED)

taskgraph - the source of the task graph event

sendid - the instance id of the sending task

sendnode - the absolute index of the sending node

recid - the instance id of the receiving task

recnode - the absolute index of the receiving node

Method Detail

getID

public int getID()

Returns:

the id of this event (either CABLE_CONNECTED, CABLE_RECONNECTED_INPUT, CABLE_RECONNECTED_OUTPUT or CABLE_DISCONNECTED)

getGroupEventID

public int getGroupEventID()

Returns:

true if this cable event is due to the cable being grouped (GROUP_EVENT) or ungrouped (UNGROUP_EVENT). Returns NON_GROUP_EVENT otherwise;

getTaskGraph

public TaskGraph getTaskGraph()

Returns:

the source of the task graph event

getCable

public Cable getCable()

Returns:

the cable being disconnected

getSendingTaskID

public java.lang.String getSendingTaskID()

Returns:

the instance id of the cable's sending task

getSendingNodeIndex

public int getSendingNodeIndex()

Returns:

the absolute index of the cable's sending node

getReceivingTaskID

public java.lang.String getReceivingTaskID()

Returns:

the instance of the cable's receiving task

getReceivingNodeIndex

public int getReceivingNodeIndex()

Returns:

the absolute index of the cable's receiving node