drcl.net.tool
Class NamTrace

java.lang.Object
  drcl.DrclObj
      drcl.comp.Component
          drcl.comp.Extension
              drcl.net.tool.NamTrace

All Implemented Interfaces:

java.lang.Cloneable, ObjectDuplicable, java.io.Serializable

Direct Known Subclasses:

NamTrace, NamTrace

public class NamTrace

extends Extension

The base class for generating NAM traces for incoming packets. The NAM traces are output at the "output@" port. One may connect it to a file component to actually write the traces to a file. Specifically, it recognizes the following five NAM packet events by the ID of the port at which packets come: hop, receive, drop, enque and deque. (For drop events, this component expects to receive GarbageContract.Message.)

Below are the ways it obtains pieces of information that constitutes a NAM packet event:

• source and destination: also in the ID of the port at which packets arrive.
• time: from Component.getTime().
• type: from getPacketType(Packet), by default, it uses Packet.getPacketType().
• extent: packet size from Packet.getPacketSize().
• conversation id: from getConversationID(Packet), a subclass should override this method to provide this information, by default, this method returns null and this component does not output this field.
• id: uses Packet.id (the field is maintained by NamTrace).
• attribute: from getColorID(Packet), a subclass should override this method to provide this information, by default, it always returns 0.

In addition, this class provides a set of methods to facilitate outputting node, link, and queue events as well as configuring colors.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class drcl.comp.Component

Component.Locks

Field Summary

Fields inherited from class drcl.comp.Component

FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_EXPOSED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_HAS_EXPOSED_CHILD, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND

Constructor Summary

NamTrace()

NamTrace(java.lang.String id_)

Method Summary

void	addColor(double time_, int colorid_, java.lang.String colorName_) Adds a color configuration.
void	addColor(int colorid_, java.lang.String colorName_) Adds a color configuration.
void	addColors() Adds a set of preconfigured colors .
void	addColors(java.lang.String[] colorNames_) Adds a set of colors .
void	addLink(double time_, long source_, long dest_, java.lang.String state_, java.lang.String color_) Adds a link (state changed) event.
void	addLink(double time_, long source_, long dest_, java.lang.String state_, java.lang.String color_, java.lang.String bandwidth_, java.lang.String propagationDelay_, java.lang.String orientation_) Adds a link event (complete form).
void	addLink(long source_, long dest_, java.lang.String state_, java.lang.String bandwidth_, java.lang.String propagationDelay_, java.lang.String orientation_) Adds a (initial) link event.
void	addNode(double time_, long source_, long dest_, java.lang.String state_, java.lang.String shape_, java.lang.String color_, java.lang.String prevColor_, java.lang.String label_) Adds a node event (complete form).
void	addNode(double time_, long source_, java.lang.String state_, java.lang.String color_) Adds a node (state changed) event.
void	addNode(double time_, long source_, java.lang.String state_, java.lang.String shape_, java.lang.String color_, java.lang.String prevColor_, java.lang.String label_) Adds a node (state changed) event.
void	addNode(long source_, java.lang.String state_, java.lang.String shape_, java.lang.String color_, java.lang.String label_) Adds a (initial) node event.
void	addQueue(double time_, long source_, long dest_, java.lang.String attribute_) Adds a queue event.
void	addQueue(long source_, long dest_, java.lang.String attribute_) Adds a queue event.
void	duplicate(java.lang.Object source_) Duplicates the content of source_, including ID, name, child components and connections among them, to this component.
int	getColorID(Packet p_)
java.lang.String	getConversationID(Packet p_)
java.lang.String	getPacketType(Packet p_)
java.lang.String	info() Returns information regarding this component.
boolean	isAccountingEnabled() Returns true if accounting of each type of event is enabled.
boolean	isComponentMessageFeedbackEnabled() Returns true if component message feedback through this component's infoport is enabled.
protected void	process(java.lang.Object data_, Port inPort_) The main callback method of a component.
void	reset() Resets the component for being used anew.
void	setAccountingEnabled(boolean enabled_) Sets true to enable accounting of each type of event.
void	setComponentMessageFeedbackEnabled(boolean enabled_) Sets true to enable component message feedback through this component's infoport.

Methods inherited from class drcl.comp.Extension

isExtensionEnabled, portAdded, setExtensionEnabled

Methods inherited from class drcl.comp.Component

_resume, _start, _stop, addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, componentAdded, componentRemoved, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, finishing, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getForkManager, getID, getName, getParent, getPort, getPort, getRoot, getRuntime, getTime, iduplicate, isAncestorOf, isComponentNotificationEnabled, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortNotificationEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, portRemoved, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setComponentNotificationEnabled, setContract, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setPortNotificationEnabled, setPortRemovable, setRuntime, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait, yield

Methods inherited from class drcl.DrclObj

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

NamTrace

public NamTrace()

NamTrace

public NamTrace(java.lang.String id_)

Method Detail

reset

public void reset()

Description copied from class: Component

Resets the component for being used anew. All the internal variables must be set to the initial state. All the ports and child components are reset as well.

Overrides:

reset in class Component

duplicate

public void duplicate(java.lang.Object source_)

Description copied from class: Component

Duplicates the content of source_, including ID, name, child components and connections among them, to this component. Subclasses need to override this method to copy its own variables.

Specified by:

duplicate in interface ObjectDuplicable

Overrides:

duplicate in class Component

info

public java.lang.String info()

Description copied from class: Component

Returns information regarding this component. Subclasses should override this method to provide useful information at run time.

Overrides:

info in class Component

process

protected void process(java.lang.Object data_,
                       Port inPort_)

Description copied from class: Component

The main callback method of a component. Being invoked when data arrives at a port of its.

Overrides:

process in class Component

Parameters:

data_ - the arrival data.

inPort_ - the port where the data arrives.

getConversationID

public java.lang.String getConversationID(Packet p_)

getColorID

public int getColorID(Packet p_)

getPacketType

public java.lang.String getPacketType(Packet p_)

setAccountingEnabled

public void setAccountingEnabled(boolean enabled_)

Sets true to enable accounting of each type of event.

isAccountingEnabled

public boolean isAccountingEnabled()

Returns true if accounting of each type of event is enabled.

setComponentMessageFeedbackEnabled

public void setComponentMessageFeedbackEnabled(boolean enabled_)

Sets true to enable component message feedback through this component's infoport.

isComponentMessageFeedbackEnabled

public boolean isComponentMessageFeedbackEnabled()

Returns true if component message feedback through this component's infoport is enabled.

addLink

public void addLink(double time_,
                    long source_,
                    long dest_,
                    java.lang.String state_,
                    java.lang.String color_,
                    java.lang.String bandwidth_,
                    java.lang.String propagationDelay_,
                    java.lang.String orientation_)

Adds a link event (complete form).

addLink

public void addLink(long source_,
                    long dest_,
                    java.lang.String state_,
                    java.lang.String bandwidth_,
                    java.lang.String propagationDelay_,
                    java.lang.String orientation_)

Adds a (initial) link event.

addLink

public void addLink(double time_,
                    long source_,
                    long dest_,
                    java.lang.String state_,
                    java.lang.String color_)

Adds a link (state changed) event.

addNode

public void addNode(double time_,
                    long source_,
                    long dest_,
                    java.lang.String state_,
                    java.lang.String shape_,
                    java.lang.String color_,
                    java.lang.String prevColor_,
                    java.lang.String label_)

Adds a node event (complete form).

addNode

public void addNode(long source_,
                    java.lang.String state_,
                    java.lang.String shape_,
                    java.lang.String color_,
                    java.lang.String label_)

Adds a (initial) node event.

addNode

public void addNode(double time_,
                    long source_,
                    java.lang.String state_,
                    java.lang.String color_)

Adds a node (state changed) event.

addNode

public void addNode(double time_,
                    long source_,
                    java.lang.String state_,
                    java.lang.String shape_,
                    java.lang.String color_,
                    java.lang.String prevColor_,
                    java.lang.String label_)

Adds a node (state changed) event.

addQueue

public void addQueue(double time_,
                     long source_,
                     long dest_,
                     java.lang.String attribute_)

Adds a queue event.

addQueue

public void addQueue(long source_,
                     long dest_,
                     java.lang.String attribute_)

Adds a queue event.

addColor

public void addColor(double time_,
                     int colorid_,
                     java.lang.String colorName_)

Adds a color configuration.

addColor

public void addColor(int colorid_,
                     java.lang.String colorName_)

Adds a color configuration.

addColors

public void addColors(java.lang.String[] colorNames_)

Adds a set of colors .

addColors

public void addColors()

Adds a set of preconfigured colors .