TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.models.trace
Interface TRCMethod

All Superinterfaces:
org.eclipse.emf.ecore.EObject, IDeltaManager, org.eclipse.emf.common.notify.Notifier, TRCLanguageElement
All Known Subinterfaces:
TRCMethodWithLLData
All Known Implementing Classes:
TRCMethodImpl, TRCMethodWithLLDataImpl

public interface TRCMethod
extends TRCLanguageElement, IDeltaManager

A representation of the model object 'TRC Method'.

See Also:
TracePackage.getTRCMethod()
Generated
[EMF] Model
[EMF] Extends
org.eclipse.hyades.loaders.trace.IDeltaManager A method definition

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
 double getCumulativeTime()
          Returns the value of the 'Cumulative Time' attribute
 TRCClass getDefiningClass()
          Returns the value of the 'Defining Class' container reference.
 int getId()
          Returns the value of the 'Id' attribute
 org.eclipse.emf.common.util.EList getInvocations()
          Returns the value of the 'Invocations' reference list.
 int getLineCount()
          Returns the value of the 'Line Count' attribute
 int getLineNo()
          Returns the value of the 'Line No' attribute
 int getModifier()
          Returns the value of the 'Modifier' attribute
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 TRCSignatureNotation getNotation()
          Returns the value of the 'Notation' attribute.
 java.lang.String getSignature()
          Returns the value of the 'Signature' attribute
 double getTotalCpuTime()
          Returns the value of the 'Total Cpu Time' 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 setCumulativeTime(double value)
          Sets the value of the 'Cumulative Time' attribute
 void setDefiningClass(TRCClass value)
          Sets the value of the 'Defining Class' container reference
 void setId(int value)
          Sets the value of the 'Id' 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 setModifier(int value)
          Sets the value of the 'Modifier' attribute
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setNotation(TRCSignatureNotation value)
          Sets the value of the 'Notation' attribute
 void setSignature(java.lang.String value)
          Sets the value of the 'Signature' attribute
 void setTotalCpuTime(double value)
          Sets the value of the 'Total Cpu 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 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...

See TRCClass.id

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

setId

public 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

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 name of the method. This can have language specific names like and in Java, which can be translated in more descriptive names (init will become the same as the name of the class). In order to get a fully qualified name you can navigate to the class and package.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), TracePackage.getTRCMethod_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

getSignature

public java.lang.String getSignature()
Returns the value of the 'Signature' attribute.

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

The full signature of the method using the notation described in TRCMethod.notation. (eg. "(Ljava/lang/String;)Z" for "boolean methodName(String s)" in JNI notation).

Returns:
the value of the 'Signature' attribute.
See Also:
setSignature(String), TracePackage.getTRCMethod_Signature()
Generated
[EMF] Model

setSignature

public void setSignature(java.lang.String value)
Sets the value of the 'Signature' attribute.

Parameters:
value - the new value of the 'Signature' attribute.
See Also:
getSignature()
Generated

getModifier

public int getModifier()
Returns the value of the 'Modifier' attribute.

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

This will be set with a combination of bitmasks defined by the values from TRCMethodProperties

Returns:
the value of the 'Modifier' attribute.
See Also:
setModifier(int), TracePackage.getTRCMethod_Modifier()
Generated
[EMF] Model

setModifier

public void setModifier(int value)
Sets the value of the 'Modifier' attribute.

Parameters:
value - the new value of the 'Modifier' attribute.
See Also:
getModifier()
Generated

getNotation

public TRCSignatureNotation getNotation()
Returns the value of the 'Notation' attribute. The literals are from the enumeration TRCSignatureNotation.

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

The notation format (use to select the decoding mechanism of the signature, eg. "JNI" notation)

Returns:
the value of the 'Notation' attribute.
See Also:
TRCSignatureNotation, setNotation(TRCSignatureNotation), TracePackage.getTRCMethod_Notation()
Generated
[EMF] Model

setNotation

public void setNotation(TRCSignatureNotation value)
Sets the value of the 'Notation' attribute.

Parameters:
value - the new value of the 'Notation' attribute.
See Also:
TRCSignatureNotation, getNotation()
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 SourceInfo where this method declaration starts. This is only as precise as the data collection can provide. Depending on the compiler, it may be a starting brace, the start of the actual signature declaration, or something else.

Returns:
the value of the 'Line No' attribute.
See Also:
setLineNo(int), TracePackage.getTRCMethod_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 method. This is only as precise as the data collection can provide.

Returns:
the value of the 'Line Count' attribute.
See Also:
setLineCount(int), TracePackage.getTRCMethod_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.getTRCMethod_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.getTRCMethod_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.getTRCMethod_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

getTotalCpuTime

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

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

getDefiningClass

public TRCClass getDefiningClass()
Returns the value of the 'Defining Class' container reference. It is bidirectional and its opposite is 'Methods'.

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

Returns:
the value of the 'Defining Class' container reference.
See Also:
setDefiningClass(TRCClass), TracePackage.getTRCMethod_DefiningClass(), TRCClass.getMethods()
Generated
[EMF] Model
opposite="methods" required="true"

setDefiningClass

public void setDefiningClass(TRCClass value)
Sets the value of the 'Defining Class' container reference.

Parameters:
value - the new value of the 'Defining Class' container reference.
See Also:
getDefiningClass()
Generated

getInvocations

public org.eclipse.emf.common.util.EList getInvocations()
Returns the value of the 'Invocations' reference list. The list contents are of type TRCMethodInvocation. It is bidirectional and its opposite is 'Method'.

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

transient

Returns:
the value of the 'Invocations' reference list.
See Also:
TracePackage.getTRCMethod_Invocations(), TRCMethodInvocation.getMethod()
Generated
[EMF] Model
type="org.eclipse.hyades.models.trace.TRCMethodInvocation" opposite="method" transient="true"

TPTP 4.4.0 Platform Project
Public API Specification