TPTP 4.6.0 Platform Project
Public API Specification

org.eclipse.hyades.models.trace
Interface TRCThread

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
TRCThreadImpl

public interface TRCThread
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'TRC Thread'. A monitored thread, scoped by its owning process.

The following features are supported:

See Also:
TracePackage.getTRCThread()
Generated
[EMF] Model

Method Summary
 org.eclipse.emf.common.util.EList<TRCAnnotation> getAnnotations()
          Returns the value of the 'Annotations' containment reference list.
 java.lang.String getGroupName()
          Returns the value of the 'Group Name' attribute
 int getId()
          Returns the value of the 'Id' attribute
 org.eclipse.emf.common.util.EList<TRCMethodInvocation> getInitialInvocations()
          Returns the value of the 'Initial Invocations' reference list.
 int getMaxStackDepth()
          Returns the value of the 'Max Stack Depth' attribute
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 TRCProcess getProcess()
          Returns the value of the 'Process' container reference.
 double getStartTime()
          Returns the value of the 'Start Time' attribute
 double getStopTime()
          Returns the value of the 'Stop Time' attribute
 org.eclipse.emf.common.util.EList<TRCThreadEvent> getThreadEvents()
          Returns the value of the 'Thread Events' containment reference list.
 TRCObject getThreadObject()
          Returns the value of the 'Thread Object' reference
 double getTotalCpuTime()
          Returns the value of the 'Total Cpu Time' attribute
 void setGroupName(java.lang.String value)
          Sets the value of the 'Group Name' attribute
 void setId(int value)
          Sets the value of the 'Id' attribute
 void setMaxStackDepth(int value)
          Sets the value of the 'Max Stack Depth' attribute
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setProcess(TRCProcess value)
          Sets the value of the 'Process' container reference
 void setStartTime(double value)
          Sets the value of the 'Start Time' attribute
 void setStopTime(double value)
          Sets the value of the 'Stop Time' attribute
 void setThreadObject(TRCObject value)
          Sets the value of the 'Thread Object' reference
 void setTotalCpuTime(double value)
          Sets the value of the 'Total Cpu Time' attribute
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getId

int getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

A unique thread ID assigned by the agent. Even if the monitored environment can re-use thread IDs, this must be unique.

Returns:
the value of the 'Id' attribute.
See Also:
setId(int), TracePackage.getTRCThread_Id()
Generated
[EMF] Model

setId

void setId(int value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

The name of the thread, to the extent it is available from the monitored environment.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), TracePackage.getTRCThread_Name()
Generated
[EMF] Model

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()
Generated

getGroupName

java.lang.String getGroupName()
Returns the value of the 'Group Name' attribute.

If the meaning of the 'Group Name' attribute isn't clear, there really should be more of a description here...

The thread's group name. This is Java specific

Returns:
the value of the 'Group Name' attribute.
See Also:
setGroupName(String), TracePackage.getTRCThread_GroupName()
Generated
[EMF] Model

setGroupName

void setGroupName(java.lang.String value)
Sets the value of the 'Group Name' attribute.

Parameters:
value - the new value of the 'Group Name' attribute.
See Also:
getGroupName()
Generated

getStartTime

double getStartTime()
Returns the value of the 'Start Time' attribute.

If the meaning of the 'Start Time' attribute isn't clear, there really should be more of a description here...

The thread start time, relative to hierarchy.TRCAgent.startTime

Returns:
the value of the 'Start Time' attribute.
See Also:
setStartTime(double), TracePackage.getTRCThread_StartTime()
Generated
[EMF] Model

setStartTime

void setStartTime(double value)
Sets the value of the 'Start Time' attribute.

Parameters:
value - the new value of the 'Start Time' attribute.
See Also:
getStartTime()
Generated

getStopTime

double getStopTime()
Returns the value of the 'Stop Time' attribute.

If the meaning of the 'Stop Time' attribute isn't clear, there really should be more of a description here...

The thread stop time, relative to hierarchy.TRCAgent.startTime

Returns:
the value of the 'Stop Time' attribute.
See Also:
setStopTime(double), TracePackage.getTRCThread_StopTime()
Generated
[EMF] Model

setStopTime

void setStopTime(double value)
Sets the value of the 'Stop Time' attribute.

Parameters:
value - the new value of the 'Stop Time' attribute.
See Also:
getStopTime()
Generated

getMaxStackDepth

int getMaxStackDepth()
Returns the value of the 'Max Stack Depth' attribute.

If the meaning of the 'Max Stack Depth' attribute isn't clear, there really should be more of a description here...

The maximum stack depth reached in this thread during a specific monitoring session. A value of zero indicates the depth has not bee calculated, or there has been no observed activity on this thread.

Returns:
the value of the 'Max Stack Depth' attribute.
See Also:
setMaxStackDepth(int), TracePackage.getTRCThread_MaxStackDepth()
Generated
[EMF] Model

setMaxStackDepth

void setMaxStackDepth(int value)
Sets the value of the 'Max Stack Depth' attribute.

Parameters:
value - the new value of the 'Max Stack Depth' attribute.
See Also:
getMaxStackDepth()
Generated

getTotalCpuTime

double getTotalCpuTime()
Returns the value of the 'Total Cpu Time' attribute. Holds the thread CPU time consumed by all method invocations on this thread

Returns:
the value of the 'Total Cpu Time' attribute.
See Also:
setTotalCpuTime(double), TracePackage.getTRCThread_TotalCpuTime()
Generated
[EMF] Model

setTotalCpuTime

void setTotalCpuTime(double value)
Sets the value of the 'Total Cpu Time' attribute.

Parameters:
value - the new value of the 'Total Cpu Time' attribute.
See Also:
getTotalCpuTime()
Generated

getProcess

TRCProcess getProcess()
Returns the value of the 'Process' container reference. It is bidirectional and its opposite is 'Threads'.

If the meaning of the 'Process' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Process' container reference.
See Also:
setProcess(TRCProcess), TracePackage.getTRCThread_Process(), TRCProcess.getThreads()
Generated
[EMF] Model
opposite="threads" required="true"

setProcess

void setProcess(TRCProcess value)
Sets the value of the 'Process' container reference.

Parameters:
value - the new value of the 'Process' container reference.
See Also:
getProcess()
Generated

getThreadObject

TRCObject getThreadObject()
Returns the value of the 'Thread Object' reference.

If the meaning of the 'Thread Object' reference isn't clear, there really should be more of a description here...

transient

Returns:
the value of the 'Thread Object' reference.
See Also:
setThreadObject(TRCObject), TracePackage.getTRCThread_ThreadObject()
Generated
[EMF] Model

setThreadObject

void setThreadObject(TRCObject value)
Sets the value of the 'Thread Object' reference.

Parameters:
value - the new value of the 'Thread Object' reference.
See Also:
getThreadObject()
Generated

getThreadEvents

org.eclipse.emf.common.util.EList<TRCThreadEvent> getThreadEvents()
Returns the value of the 'Thread Events' containment reference list. The list contents are of type TRCThreadEvent. It is bidirectional and its opposite is 'Thread'.

If the meaning of the 'Thread Events' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Thread Events' containment reference list.
See Also:
TracePackage.getTRCThread_ThreadEvents(), TRCThreadEvent.getThread()
Generated
[EMF] Model
opposite="thread" containment="true"

getAnnotations

org.eclipse.emf.common.util.EList<TRCAnnotation> getAnnotations()
Returns the value of the 'Annotations' containment reference list. The list contents are of type TRCAnnotation.

If the meaning of the 'Annotations' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Annotations' containment reference list.
See Also:
TracePackage.getTRCThread_Annotations()
Generated
[EMF] Model
containment="true"

getInitialInvocations

org.eclipse.emf.common.util.EList<TRCMethodInvocation> getInitialInvocations()
Returns the value of the 'Initial Invocations' reference list. The list contents are of type TRCMethodInvocation.

If the meaning of the 'Initial Invocations' reference list isn't clear, there really should be more of a description here...

transient

Returns:
the value of the 'Initial Invocations' reference list.
See Also:
TracePackage.getTRCThread_InitialInvocations()
Generated
[EMF] Model

TPTP 4.6.0 Platform Project
Public API Specification