TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.models.trace
Interface TRCPackage

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

public interface TRCPackage
extends TRCLanguageElement, IDeltaManager

A representation of the model object 'TRC Package'.

See Also:
TracePackage.getTRCPackage()
Generated
[EMF] Model
[EMF] Extends
org.eclipse.hyades.loaders.trace.IDeltaManager Logical representation of a Java package - 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
 org.eclipse.emf.common.util.EList getClasses()
          Returns the value of the 'Classes' containment 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
 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
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 TRCPackage getParent()
          Returns the value of the 'Parent' reference.
 TRCProcess getProcess()
          Returns the value of the 'Process' container reference.
 org.eclipse.emf.common.util.EList getSubPackages()
          Returns the value of the 'Sub Packages' reference list.
 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
 void setBaseTime(double value)
          Sets the value of the 'Base Time' attribute
 void setCalls(int value)
          Sets the value of the 'Calls' attribute
 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 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 setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setParent(TRCPackage value)
          Sets the value of the 'Parent' reference
 void setProcess(TRCProcess value)
          Sets the value of the 'Process' container reference
 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
 
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

getName

public java.lang.String getName()
Returns the value of the 'Name' attribute. The default value is "Default".

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

The fully qualified name of the package. The dot separated notation is used. This may become more complex once further language-neutrality is added to the model.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), TracePackage.getTRCPackage_Name()
Generated
[EMF] Model
default="Default"

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

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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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.getTRCPackage_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 of all classes in this package

Returns:
the value of the 'Total Cpu Time' attribute.
See Also:
setTotalCpuTime(double), TracePackage.getTRCPackage_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

getProcess

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

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.getTRCPackage_Process(), TRCProcess.getPackages()
Generated
[EMF] Model
opposite="packages" required="true"

setProcess

public 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

getClasses

public org.eclipse.emf.common.util.EList getClasses()
Returns the value of the 'Classes' containment reference list. The list contents are of type TRCClass. It is bidirectional and its opposite is 'Package'.

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

Returns:
the value of the 'Classes' containment reference list.
See Also:
TracePackage.getTRCPackage_Classes(), TRCClass.getPackage()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCClass" opposite="package" containment="true"

getSubPackages

public org.eclipse.emf.common.util.EList getSubPackages()
Returns the value of the 'Sub Packages' reference list. The list contents are of type TRCPackage. It is bidirectional and its opposite is 'Parent'.

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

Returns:
the value of the 'Sub Packages' reference list.
See Also:
TracePackage.getTRCPackage_SubPackages(), getParent()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCPackage" opposite="parent"

getParent

public TRCPackage getParent()
Returns the value of the 'Parent' reference. It is bidirectional and its opposite is 'Sub Packages'.

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

Returns:
the value of the 'Parent' reference.
See Also:
setParent(TRCPackage), TracePackage.getTRCPackage_Parent(), getSubPackages()
Generated
[EMF] Model
opposite="subPackages"

setParent

public void setParent(TRCPackage value)
Sets the value of the 'Parent' reference.

Parameters:
value - the new value of the 'Parent' reference.
See Also:
getParent()
Generated

TPTP 4.4.0 Platform Project
Public API Specification