org.eclipse.hyades.models.trace
Interface TRCFullMethodInvocation

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, TRCMethodInvocation

All Known Subinterfaces:

TRCCallerCalleeInvocationInfo

All Known Implementing Classes:

TRCCallerCalleeInvocationInfoImpl, TRCFullMethodInvocationImpl

public interface TRCFullMethodInvocation

extends TRCMethodInvocation

A representation of the model object 'TRC Full Method Invocation'. TRCFullMethodInvocation carries attributes about a method invocation that are used when the agent was tracking performance information about each function call.

The following features are supported:

• Stack Depth
• Entry Time
• Exit Time
• Ticket
• Overhead
• Caller Line No
• Cpu Time

See Also:

TracePackage.getTRCFullMethodInvocation()

Method Summary

int	getCallerLineNo() Returns the value of the 'Caller Line No' attribute.
double	getCpuTime() Returns the value of the 'Cpu Time' attribute.
double	getEntryTime() Returns the value of the 'Entry Time' attribute.
double	getExitTime() Returns the value of the 'Exit Time' attribute.
double	getOverhead() Returns the value of the 'Overhead' attribute.
short	getStackDepth() Returns the value of the 'Stack Depth' attribute.
long	getTicket() Returns the value of the 'Ticket' attribute.
void	setCallerLineNo(int value) Sets the value of the 'Caller Line No' attribute.
void	setCpuTime(double value) Sets the value of the 'Cpu Time' attribute.
void	setEntryTime(double value) Sets the value of the 'Entry Time' attribute.
void	setExitTime(double value) Sets the value of the 'Exit Time' attribute.
void	setOverhead(double value) Sets the value of the 'Overhead' attribute.
void	setStackDepth(short value) Sets the value of the 'Stack Depth' attribute.
void	setTicket(long value) Sets the value of the 'Ticket' attribute.

Methods inherited from interface org.eclipse.hyades.models.trace.TRCMethodInvocation

getInvokedBy, getInvokes, getMethod, getOwningObject, getProcess, getThread, setInvokedBy, setMethod, setOwningObject, setProcess, setThread

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

getStackDepth

public short getStackDepth()

Returns the value of the 'Stack Depth' attribute.

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

The true stack depth for this invocation, even counting stack frames which don't appear in the TRCMethodInvocation.invokes chain.

Returns:

the value of the 'Stack Depth' attribute.

See Also:

setStackDepth(short), TracePackage.getTRCFullMethodInvocation_StackDepth()

setStackDepth

public void setStackDepth(short value)

Sets the value of the 'Stack Depth' attribute.

Parameters:

value - the new value of the 'Stack Depth' attribute.

See Also:

getStackDepth()

getEntryTime

public double getEntryTime()

Returns the value of the 'Entry Time' attribute.

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

Method entry time, relative to hierarchy.TRCAgent.startTime

Returns:

the value of the 'Entry Time' attribute.

See Also:

setEntryTime(double), TracePackage.getTRCFullMethodInvocation_EntryTime()

setEntryTime

public void setEntryTime(double value)

Sets the value of the 'Entry Time' attribute.

Parameters:

value - the new value of the 'Entry Time' attribute.

See Also:

getEntryTime()

getExitTime

public double getExitTime()

Returns the value of the 'Exit Time' attribute.

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

Method exit time, relative to hierarchy.TRCAgent.startTime

Returns:

the value of the 'Exit Time' attribute.

See Also:

setExitTime(double), TracePackage.getTRCFullMethodInvocation_ExitTime()

setExitTime

public void setExitTime(double value)

Sets the value of the 'Exit Time' attribute.

Parameters:

value - the new value of the 'Exit Time' attribute.

See Also:

getExitTime()

getTicket

public long getTicket()

Returns the value of the 'Ticket' attribute.

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

A ticket is a sequential incremental counter used to correlate invocations that can not be sorted by time alone. This allows for events to arrive out of sequence or for invocations to filtered out and skipped.

Returns:

the value of the 'Ticket' attribute.

See Also:

setTicket(long), TracePackage.getTRCFullMethodInvocation_Ticket()

setTicket

public void setTicket(long value)

Sets the value of the 'Ticket' attribute.

Parameters:

value - the new value of the 'Ticket' attribute.

See Also:

getTicket()

getOverhead

public double getOverhead()

Returns the value of the 'Overhead' attribute. The default value is "0.0".

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

Overhead introduced by tracing the application. Tracking this time on a per-invocation basis is important because the cost of tracing is not uniform.

Returns:

the value of the 'Overhead' attribute.

See Also:

setOverhead(double), TracePackage.getTRCFullMethodInvocation_Overhead()

setOverhead

public void setOverhead(double value)

Sets the value of the 'Overhead' attribute.

Parameters:

value - the new value of the 'Overhead' attribute.

See Also:

getOverhead()

getCallerLineNo

public int getCallerLineNo()

Returns the value of the 'Caller Line No' attribute.

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

The source line number of the calling statement.

Returns:

the value of the 'Caller Line No' attribute.

See Also:

setCallerLineNo(int), TracePackage.getTRCFullMethodInvocation_CallerLineNo()

setCallerLineNo

public void setCallerLineNo(int value)

Sets the value of the 'Caller Line No' attribute.

Parameters:

value - the new value of the 'Caller Line No' attribute.

See Also:

getCallerLineNo()

getCpuTime

public double getCpuTime()

Returns the value of the 'Cpu Time' attribute. Holds the thread CPU time consumed during the execution of this call invocation. Note the "TRCFullMethodInvocation" includes an existing "double" attribute "overhead" which is currently used as the instrumentation overhead in elapsed time measurement. When "cpuTime" is set this "overhead" attribute will also apply to both elapsed and CPU calculation (Duration = exitTime - entryTime - overhead) and in calculating the raw CPU time (Method CPU Time = cpuTime - overhead)

Returns:

the value of the 'Cpu Time' attribute.

See Also:

setCpuTime(double), TracePackage.getTRCFullMethodInvocation_CpuTime()

setCpuTime

public void setCpuTime(double value)

Sets the value of the 'Cpu Time' attribute.

Parameters:

value - the new value of the 'Cpu Time' attribute.

See Also:

getCpuTime()