TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.hyades.models.trace
Interface TRCClass

All Superinterfaces:
org.eclipse.emf.ecore.EObject, IDeltaManager, org.eclipse.emf.common.notify.Notifier, TRCLanguageElement
All Known Subinterfaces:
TRCArrayClass
All Known Implementing Classes:
TRCArrayClassImpl, TRCClassImpl

public interface TRCClass
extends TRCLanguageElement, IDeltaManager

A representation of the model object 'TRC Class'.

See Also:
TracePackage.getTRCClass()
Generated
[EMF] Model
[EMF] Extends
org.eclipse.hyades.loaders.trace.IDeltaManager This represents a complex type (a Java class for example) - calls, baseTime, and cumulativeTime: these are aggregate measures of all the method invocations whose receiver object is of the given class (or package, or process). For cumulativeTime, time spent in any method invocations that call each other is not counted more than once for that class (or package, or process). - inheritedCalls, inheritedBaseTime, and inheritedCumulativeTime: these are aggregate measures of all the method invocations whose receiver object is of the given class (or package, or process), but limited to those whose method is not implemented in the class of the receiver object (i.e. it is implemented in a class further up in the class hierarchy).

The following features are supported:


Method Summary
 double getBaseTime()
          Returns the value of the 'Base Time' attribute
 int getCalls()
          Returns the value of the 'Calls' attribute
 TRCClassLoader getClassLoader()
          Returns the value of the 'Class Loader' reference
 org.eclipse.emf.common.util.EList getClassObjects()
          Returns the value of the 'Class Objects' reference list.
 int getCollectedInstances()
          Returns the value of the 'Collected Instances' attribute
 int getCollectedSize()
          Returns the value of the 'Collected Size' attribute
 double getCumulativeTime()
          Returns the value of the 'Cumulative Time' attribute
 TRCClass getEnclosedBy()
          Returns the value of the 'Enclosed By' reference
 org.eclipse.emf.common.util.EList getExtends()
          Returns the value of the 'Extends' reference list.
 long getId()
          Returns the value of the 'Id' attribute
 org.eclipse.emf.common.util.EList getImplements()
          Returns the value of the 'Implements' reference list.
 double getInheritedBaseTime()
          Returns the value of the 'Inherited Base Time' attribute
 int getInheritedCalls()
          Returns the value of the 'Inherited Calls' attribute
 double getInheritedCumulativeTime()
          Returns the value of the 'Inherited Cumulative Time' attribute
 int getLineCount()
          Returns the value of the 'Line Count' attribute
 int getLineNo()
          Returns the value of the 'Line No' attribute
 TRCThread getLoadedBy()
          Returns the value of the 'Loaded By' reference
 double getLoadTime()
          Returns the value of the 'Load Time' attribute
 org.eclipse.emf.common.util.EList getLocks()
          Returns the value of the 'Locks' reference list.
 org.eclipse.emf.common.util.EList getMethods()
          Returns the value of the 'Methods' containment reference list.
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 org.eclipse.emf.common.util.EList getObjects()
          Returns the value of the 'Objects' reference list.
 TRCPackage getPackage()
          Returns the value of the 'Package' container reference.
 int getSize()
          Returns the value of the 'Size' attribute
 double getTotalCpuTime()
          Returns the value of the 'Total Cpu Time' attribute
 int getTotalInstances()
          Returns the value of the 'Total Instances' attribute
 int getTotalSize()
          Returns the value of the 'Total Size' attribute
 double getUnloadTime()
          Returns the value of the 'Unload Time' attribute
 boolean isInterface()
          Returns the value of the 'Interface' attribute
 void setBaseTime(double value)
          Sets the value of the 'Base Time' attribute
 void setCalls(int value)
          Sets the value of the 'Calls' attribute
 void setClassLoader(TRCClassLoader value)
          Sets the value of the 'Class Loader' reference
 void setCollectedInstances(int value)
          Sets the value of the 'Collected Instances' attribute
 void setCollectedSize(int value)
          Sets the value of the 'Collected Size' attribute
 void setCumulativeTime(double value)
          Sets the value of the 'Cumulative Time' attribute
 void setEnclosedBy(TRCClass value)
          Sets the value of the 'Enclosed By' reference
 void setId(long value)
          Sets the value of the 'Id' attribute
 void setInheritedBaseTime(double value)
          Sets the value of the 'Inherited Base Time' attribute
 void setInheritedCalls(int value)
          Sets the value of the 'Inherited Calls' attribute
 void setInheritedCumulativeTime(double value)
          Sets the value of the 'Inherited Cumulative Time' attribute
 void setInterface(boolean value)
          Sets the value of the 'Interface' attribute
 void setLineCount(int value)
          Sets the value of the 'Line Count' attribute
 void setLineNo(int value)
          Sets the value of the 'Line No' attribute
 void setLoadedBy(TRCThread value)
          Sets the value of the 'Loaded By' reference
 void setLoadTime(double value)
          Sets the value of the 'Load Time' attribute
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setPackage(TRCPackage value)
          Sets the value of the 'Package' container reference
 void setSize(int value)
          Sets the value of the 'Size' attribute
 void setTotalCpuTime(double value)
          Sets the value of the 'Total Cpu Time' attribute
 void setTotalInstances(int value)
          Sets the value of the 'Total Instances' attribute
 void setTotalSize(int value)
          Sets the value of the 'Total Size' attribute
 void setUnloadTime(double value)
          Sets the value of the 'Unload Time' attribute
 
Methods inherited from interface org.eclipse.hyades.models.trace.TRCLanguageElement
getAnnotations, getSourceInfo, setSourceInfo
 
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
 
Methods inherited from interface org.eclipse.hyades.loaders.trace.IDeltaManager
computeDelta, computeDelta, removeSnapshot, retrieveSnapshot, takeSnapshot
 

Method Detail

getId

public long 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...

An unique ID for this class during a monitoring session. By persisting this we can have sessions with disconnected segments, e.g. attach, start monitoring, pause monitoring, shutdown client, restart client, re-attach to same session and continue monitoring.

Returns:
the value of the 'Id' attribute.
See Also:
setId(long), TracePackage.getTRCClass_Id()
Generated
[EMF] Model
dataType="org.eclipse.hyades.models.trace.EClassID"

setId

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

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

getName

public 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 class name, without the package qualified part of the name. In the case of synthetic names they will be captured in the form that is meaningful to the synthesizer. Classes where the name is unknown will have a class name of _unknown.

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

setName

public 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

getSize

public int getSize()
Returns the value of the 'Size' attribute.

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

The size of one instance of this class. If the class is an array, this field specifies the size of the type of the elements in the array and the size of array it is specified in the size field of TRCArrayObject. [Note: the representation of array types is undergoing design changes.]

Returns:
the value of the 'Size' attribute.
See Also:
setSize(int), TracePackage.getTRCClass_Size()
Generated
[EMF] Model

setSize

public void setSize(int value)
Sets the value of the 'Size' attribute.

Parameters:
value - the new value of the 'Size' attribute.
See Also:
getSize()
Generated

getLoadTime

public double getLoadTime()
Returns the value of the 'Load Time' attribute.

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

When the class was loaded, relative to hierarchy.TRCAgent.startTime

Returns:
the value of the 'Load Time' attribute.
See Also:
setLoadTime(double), TracePackage.getTRCClass_LoadTime()
Generated
[EMF] Model

setLoadTime

public void setLoadTime(double value)
Sets the value of the 'Load Time' attribute.

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

getUnloadTime

public double getUnloadTime()
Returns the value of the 'Unload Time' attribute.

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

When the class was unloaded, relative to hierarchy.TRCAgent.startTime

Returns:
the value of the 'Unload Time' attribute.
See Also:
setUnloadTime(double), TracePackage.getTRCClass_UnloadTime()
Generated
[EMF] Model

setUnloadTime

public void setUnloadTime(double value)
Sets the value of the 'Unload Time' attribute.

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

isInterface

public boolean isInterface()
Returns the value of the 'Interface' attribute.

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

True if the class is an interface

Returns:
the value of the 'Interface' attribute.
See Also:
setInterface(boolean), TracePackage.getTRCClass_Interface()
Generated
[EMF] Model

setInterface

public void setInterface(boolean value)
Sets the value of the 'Interface' attribute.

Parameters:
value - the new value of the 'Interface' attribute.
See Also:
isInterface()
Generated

getLineNo

public int getLineNo()
Returns the value of the 'Line No' attribute.

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

The line number in the source info where the declaration of this class starts.

Returns:
the value of the 'Line No' attribute.
See Also:
setLineNo(int), TracePackage.getTRCClass_LineNo()
Generated
[EMF] Model

setLineNo

public void setLineNo(int value)
Sets the value of the 'Line No' attribute.

Parameters:
value - the new value of the 'Line No' attribute.
See Also:
getLineNo()
Generated

getLineCount

public int getLineCount()
Returns the value of the 'Line Count' attribute. The line count of the body of this class. This is only as precise as the data collection can provide.

Returns:
the value of the 'Line Count' attribute.
See Also:
setLineCount(int), TracePackage.getTRCClass_LineCount()
Generated
[EMF] Model

setLineCount

public void setLineCount(int value)
Sets the value of the 'Line Count' attribute.

Parameters:
value - the new value of the 'Line Count' attribute.
See Also:
getLineCount()
Generated

getBaseTime

public double getBaseTime()
Returns the value of the 'Base Time' attribute.

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

Time spent in methods of the owning element

Returns:
the value of the 'Base Time' attribute.
See Also:
setBaseTime(double), TracePackage.getTRCClass_BaseTime()
Generated
[EMF] Model

setBaseTime

public void setBaseTime(double value)
Sets the value of the 'Base Time' attribute.

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

getCumulativeTime

public double getCumulativeTime()
Returns the value of the 'Cumulative Time' attribute.

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

Time spent in methods of this owning element + all methods called from these methods (but owned by other elements)

Returns:
the value of the 'Cumulative Time' attribute.
See Also:
setCumulativeTime(double), TracePackage.getTRCClass_CumulativeTime()
Generated
[EMF] Model

setCumulativeTime

public void setCumulativeTime(double value)
Sets the value of the 'Cumulative Time' attribute.

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

getCalls

public int getCalls()
Returns the value of the 'Calls' attribute.

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

number of calls to the owning element

Returns:
the value of the 'Calls' attribute.
See Also:
setCalls(int), TracePackage.getTRCClass_Calls()
Generated
[EMF] Model

setCalls

public void setCalls(int value)
Sets the value of the 'Calls' attribute.

Parameters:
value - the new value of the 'Calls' attribute.
See Also:
getCalls()
Generated

getInheritedCalls

public int getInheritedCalls()
Returns the value of the 'Inherited Calls' attribute.

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

Number of calls to methods defined in superclasses of classes from the owning element

Returns:
the value of the 'Inherited Calls' attribute.
See Also:
setInheritedCalls(int), TracePackage.getTRCClass_InheritedCalls()
Generated
[EMF] Model

setInheritedCalls

public void setInheritedCalls(int value)
Sets the value of the 'Inherited Calls' attribute.

Parameters:
value - the new value of the 'Inherited Calls' attribute.
See Also:
getInheritedCalls()
Generated

getInheritedBaseTime

public double getInheritedBaseTime()
Returns the value of the 'Inherited Base Time' attribute.

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

Time spent in methods defined in superclasses of this classes from the owning element

Returns:
the value of the 'Inherited Base Time' attribute.
See Also:
setInheritedBaseTime(double), TracePackage.getTRCClass_InheritedBaseTime()
Generated
[EMF] Model

setInheritedBaseTime

public void setInheritedBaseTime(double value)
Sets the value of the 'Inherited Base Time' attribute.

Parameters:
value - the new value of the 'Inherited Base Time' attribute.
See Also:
getInheritedBaseTime()
Generated

getInheritedCumulativeTime

public double getInheritedCumulativeTime()
Returns the value of the 'Inherited Cumulative Time' attribute.

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

Time spent in methods of classes from the owning element + all methods called from the methods defined in superclasses of classes from the owning element

Returns:
the value of the 'Inherited Cumulative Time' attribute.
See Also:
setInheritedCumulativeTime(double), TracePackage.getTRCClass_InheritedCumulativeTime()
Generated
[EMF] Model

setInheritedCumulativeTime

public void setInheritedCumulativeTime(double value)
Sets the value of the 'Inherited Cumulative Time' attribute.

Parameters:
value - the new value of the 'Inherited Cumulative Time' attribute.
See Also:
getInheritedCumulativeTime()
Generated

getTotalSize

public int getTotalSize()
Returns the value of the 'Total Size' attribute.

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

The total size of memory allocated

Returns:
the value of the 'Total Size' attribute.
See Also:
setTotalSize(int), TracePackage.getTRCClass_TotalSize()
Generated
[EMF] Model

setTotalSize

public void setTotalSize(int value)
Sets the value of the 'Total Size' attribute.

Parameters:
value - the new value of the 'Total Size' attribute.
See Also:
getTotalSize()
Generated

getTotalInstances

public int getTotalInstances()
Returns the value of the 'Total Instances' attribute.

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

Number of instances created

Returns:
the value of the 'Total Instances' attribute.
See Also:
setTotalInstances(int), TracePackage.getTRCClass_TotalInstances()
Generated
[EMF] Model

setTotalInstances

public void setTotalInstances(int value)
Sets the value of the 'Total Instances' attribute.

Parameters:
value - the new value of the 'Total Instances' attribute.
See Also:
getTotalInstances()
Generated

getCollectedSize

public int getCollectedSize()
Returns the value of the 'Collected Size' attribute.

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

The total size of memory garbage collected

Returns:
the value of the 'Collected Size' attribute.
See Also:
setCollectedSize(int), TracePackage.getTRCClass_CollectedSize()
Generated
[EMF] Model

setCollectedSize

public void setCollectedSize(int value)
Sets the value of the 'Collected Size' attribute.

Parameters:
value - the new value of the 'Collected Size' attribute.
See Also:
getCollectedSize()
Generated

getCollectedInstances

public int getCollectedInstances()
Returns the value of the 'Collected Instances' attribute.

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

Number of instances garbage collected

Returns:
the value of the 'Collected Instances' attribute.
See Also:
setCollectedInstances(int), TracePackage.getTRCClass_CollectedInstances()
Generated
[EMF] Model

setCollectedInstances

public void setCollectedInstances(int value)
Sets the value of the 'Collected Instances' attribute.

Parameters:
value - the new value of the 'Collected Instances' attribute.
See Also:
getCollectedInstances()
Generated

getTotalCpuTime

public double getTotalCpuTime()
Returns the value of the 'Total Cpu Time' attribute. Holds the thread CPU time consumed by all invocations of all methods in this class.

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

setTotalCpuTime

public 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

getObjects

public org.eclipse.emf.common.util.EList getObjects()
Returns the value of the 'Objects' reference list. The list contents are of type TRCObject. It is bidirectional and its opposite is 'Is A'.

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

transient

Returns:
the value of the 'Objects' reference list.
See Also:
TracePackage.getTRCClass_Objects(), TRCObject.getIsA()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCObject" opposite="isA" transient="true"

getLoadedBy

public TRCThread getLoadedBy()
Returns the value of the 'Loaded By' reference.

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

Returns:
the value of the 'Loaded By' reference.
See Also:
setLoadedBy(TRCThread), TracePackage.getTRCClass_LoadedBy()
Generated
[EMF] Model
required="true"

setLoadedBy

public void setLoadedBy(TRCThread value)
Sets the value of the 'Loaded By' reference.

Parameters:
value - the new value of the 'Loaded By' reference.
See Also:
getLoadedBy()
Generated

getMethods

public org.eclipse.emf.common.util.EList getMethods()
Returns the value of the 'Methods' containment reference list. The list contents are of type TRCMethod. It is bidirectional and its opposite is 'Defining Class'.

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

Returns:
the value of the 'Methods' containment reference list.
See Also:
TracePackage.getTRCClass_Methods(), TRCMethod.getDefiningClass()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCMethod" opposite="definingClass" containment="true"

getClassObjects

public org.eclipse.emf.common.util.EList getClassObjects()
Returns the value of the 'Class Objects' reference list. The list contents are of type TRCObject.

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

This should be resolved only for the resources that are in memory. Usualy there are only to entries in this collection (one for heap and one for execution).

Returns:
the value of the 'Class Objects' reference list.
See Also:
TracePackage.getTRCClass_ClassObjects()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCObject"

getPackage

public TRCPackage getPackage()
Returns the value of the 'Package' container reference. It is bidirectional and its opposite is 'Classes'.

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

Returns:
the value of the 'Package' container reference.
See Also:
setPackage(TRCPackage), TracePackage.getTRCClass_Package(), TRCPackage.getClasses()
Generated
[EMF] Model
opposite="classes" required="true"

setPackage

public void setPackage(TRCPackage value)
Sets the value of the 'Package' container reference.

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

getClassLoader

public TRCClassLoader getClassLoader()
Returns the value of the 'Class Loader' reference.

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

Returns:
the value of the 'Class Loader' reference.
See Also:
setClassLoader(TRCClassLoader), TracePackage.getTRCClass_ClassLoader()
Generated
[EMF] Model

setClassLoader

public void setClassLoader(TRCClassLoader value)
Sets the value of the 'Class Loader' reference.

Parameters:
value - the new value of the 'Class Loader' reference.
See Also:
getClassLoader()
Generated

getEnclosedBy

public TRCClass getEnclosedBy()
Returns the value of the 'Enclosed By' reference.

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

Returns:
the value of the 'Enclosed By' reference.
See Also:
setEnclosedBy(TRCClass), TracePackage.getTRCClass_EnclosedBy()
Generated
[EMF] Model

setEnclosedBy

public void setEnclosedBy(TRCClass value)
Sets the value of the 'Enclosed By' reference.

Parameters:
value - the new value of the 'Enclosed By' reference.
See Also:
getEnclosedBy()
Generated

getExtends

public org.eclipse.emf.common.util.EList getExtends()
Returns the value of the 'Extends' reference list. The list contents are of type TRCClass.

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

Returns:
the value of the 'Extends' reference list.
See Also:
TracePackage.getTRCClass_Extends()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCClass"

getImplements

public org.eclipse.emf.common.util.EList getImplements()
Returns the value of the 'Implements' reference list. The list contents are of type TRCClass.

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

Returns:
the value of the 'Implements' reference list.
See Also:
TracePackage.getTRCClass_Implements()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCClass"

getLocks

public org.eclipse.emf.common.util.EList getLocks()
Returns the value of the 'Locks' reference list. The list contents are of type TRCLockAccess.

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

Returns:
the value of the 'Locks' reference list.
See Also:
TracePackage.getTRCClass_Locks()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCLockAccess"

TPTP 4.2.0 Platform Project
Public API Specification