edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope Class Reference

A scope in an HPCView experiment consisting of a range of lines. More...

Inheritance diagram for edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope:
Inheritance graph
[legend]
Collaboration diagram for edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 StatementRangeScope (BaseExperiment experiment, SourceFile file, int first, int last, int cct_id, int flat_id)
String getName ()
String getShortName ()
Scope duplicate ()
void accept (IScopeVisitor visitor, ScopeVisitType vt)
int getFlatIndex ()
int getCCTIndex ()
void incrementCounter ()
void decrementCounter ()
void setCounter (int counter)
int getCounter ()
boolean isCounterPositif ()
boolean isCounterZero ()
int getCpid ()
void setCpid (int _cpid)
String getToolTip ()
String toString ()
int hashCode ()
SourceFile getSourceFile ()
int getFirstLineNumber ()
int getLastLineNumber ()
Scope getParentScope ()
void setParentScope (Scope parentScope)
int getSubscopeCount ()
Scope getSubscope (int index)
void addSubscope (Scope subscope)
boolean hasMetrics ()
boolean hasNonzeroMetrics ()
BaseExperiment getExperiment ()
void setExperiment (BaseExperiment exp)
MetricValue getMetricValue (BaseMetric metric)
MetricValue getMetricValue (int index)
void setMetricValue (int index, MetricValue value)
void accumulateMetrics (Scope source, MetricValuePropagationFilter filter, int nMetrics)
void accumulateMetric (Scope source, int src_i, int targ_i, MetricValuePropagationFilter filter)
void backupMetricValues ()
MetricValue[] getMetricValues ()
void setMetricValues (MetricValue values[])
MetricValue[] getCombinedValues ()
void combine (Scope source, MetricValuePropagationFilter filter)
void safeCombine (Scope source, MetricValuePropagationFilter filter)
void copyMetrics (Scope targetScope, int offset)
void dfsVisitScopeTree (IScopeVisitor sv)
void dfsVisitFilterScopeTree (FilterScopeVisitor sv)
void dispose ()
boolean equals (final Object object)
Object[] getChildren ()
 Returns the child nodes.
TreeNode getParent ()
 Returns the parent node.
Object getValue ()
 Returns the value held by this node.
boolean hasChildren ()
 Returns whether the tree has any children.
void add (TreeNode child)
void remove (TreeNode child)
 Remove a child.
void remove (int index)
 Remove a child for a given index.
void setParent (final TreeNode parent)
 Sets the parent for this node.
TreeNode getChildAt (int index)
int getChildCount ()
Iterator< TreeNodegetIterator ()
 Return the iterator of the children.

Static Public Member Functions

static final int hashCode (final Object object)
 Provides a hash code for the object -- defending against null.
static final boolean equals (final Object left, final Object right)
 Checks whether the two objects are null -- allowing for null.

Public Attributes

int iSourceCodeAvailability = Scope.SOURCE_CODE_UNKNOWN

Static Public Attributes

static final int NO_LINE_NUMBER = -169
 The value used to indicate "no line number".
static final int SOURCE_CODE_UNKNOWN = 0
static final int SOURCE_CODE_AVAILABLE = 1
static final int SOURCE_CODE_NOT_AVAILABLE = 2

Protected Member Functions

String getSourceCitation ()
String getLineNumberCitation ()
void ensureMetricStorage ()
boolean isExperimentHasMetrics ()

Protected Attributes

BaseExperiment experiment
 The experiment owning this scope.
SourceFile sourceFile
 The source file containing this scope.
int flat_node_index
 the scope identifier
int firstLineNumber
 The first line number of this scope.
int lastLineNumber
 The last line number of this scope.
String srcCitation
 source citation
int cpid
Object value
 The value contained in this node.

Static Protected Attributes

static int idMax = 0
 The current maximum number of ID for all scopes.

Detailed Description

A scope in an HPCView experiment consisting of a range of lines.

Definition at line 36 of file StatementRangeScope.java.


Constructor & Destructor Documentation

edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope.StatementRangeScope ( BaseExperiment  experiment,
SourceFile  file,
int  first,
int  last,
int  cct_id,
int  flat_id 
)

Member Function Documentation

void edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope.accept ( IScopeVisitor  visitor,
ScopeVisitType  vt 
)
void edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetric ( Scope  source,
int  src_i,
int  targ_i,
MetricValuePropagationFilter  filter 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetrics ( Scope  source,
MetricValuePropagationFilter  filter,
int  nMetrics 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.TreeNode.add ( TreeNode  child  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.addSubscope ( Scope  subscope  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.backupMetricValues (  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.combine ( Scope  source,
MetricValuePropagationFilter  filter 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.copyMetrics ( Scope  targetScope,
int  offset 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.decrementCounter (  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.dfsVisitFilterScopeTree ( FilterScopeVisitor  sv  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.dfsVisitScopeTree ( IScopeVisitor  sv  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.dispose (  )  [inherited]
Scope edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope.duplicate (  )  [virtual]
void edu.rice.cs.hpc.data.experiment.scope.Scope.ensureMetricStorage (  )  [protected, inherited]
static final boolean edu.rice.cs.hpc.data.experiment.scope.TreeNode.equals ( final Object  left,
final Object  right 
) [static, inherited]

Checks whether the two objects are null -- allowing for null.

Parameters:
left The left object to compare; may be null.
right The right object to compare; may be null.
Returns:
true if the two objects are equivalent; false otherwise.

Definition at line 234 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.equals().

boolean edu.rice.cs.hpc.data.experiment.scope.TreeNode.equals ( final Object  object  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getCCTIndex (  )  [inherited]
TreeNode edu.rice.cs.hpc.data.experiment.scope.TreeNode.getChildAt ( int  index  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.TreeNode.getChildCount (  )  [inherited]
Object [] edu.rice.cs.hpc.data.experiment.scope.TreeNode.getChildren (  )  [inherited]
MetricValue [] edu.rice.cs.hpc.data.experiment.scope.Scope.getCombinedValues (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getCounter (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getCpid (  )  [inherited]
BaseExperiment edu.rice.cs.hpc.data.experiment.scope.Scope.getExperiment (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getFirstLineNumber (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getFlatIndex (  )  [inherited]
Iterator<TreeNode> edu.rice.cs.hpc.data.experiment.scope.TreeNode.getIterator (  )  [inherited]

Return the iterator of the children.


The advantage of an iterator is that it allows the caller to remove elements from the collection of children during the iteration. See java.util.Iterator

Returns:
java.util.Iterator

Definition at line 202 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.children.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.dfsVisitFilterScopeTree().

int edu.rice.cs.hpc.data.experiment.scope.Scope.getLastLineNumber (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.scope.Scope.getLineNumberCitation (  )  [protected, inherited]
MetricValue edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue ( int  index  )  [inherited]
MetricValue edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue ( BaseMetric  metric  )  [inherited]

Definition at line 524 of file Scope.java.

References edu.rice.cs.hpc.data.experiment.scope.Scope.experiment, edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getIndex(), edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), edu.rice.cs.hpc.data.experiment.BaseExperiment.getRootScope(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.getValue(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.setAnnotationValue(), and edu.rice.cs.hpc.data.experiment.scope.TreeNode.value.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.accumulateMetric(), edu.rice.cs.hpc.data.experiment.scope.visitors.ComputedMetricVisitor.addComputedMetrics(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.combine(), edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.CompareScope.compare(), edu.rice.cs.hpc.data.experiment.scope.visitors.ComputedMetricVisitor.ComputedMetricVisitor(), edu.rice.cs.hpc.data.experiment.Experiment.copyMetric(), edu.rice.cs.hpc.data.experiment.Experiment.copyMetricsToPartner(), edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedPercentVisitor.DerivedPercentVisitor(), edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.disseminateMetric(), edu.rice.cs.hpc.data.experiment.merge.TreeSimilarity.getAnnotationValue(), edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), edu.rice.cs.hpc.data.experiment.metric.Metric.getValue(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.getValue(), edu.rice.cs.hpc.data.experiment.scope.Scope.hasNonzeroMetrics(), edu.rice.cs.hpc.viewer.scope.ScopeViewActionsGUI.insertParentNode(), edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetrics(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.mergeMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetricToParent(), edu.rice.cs.hpc.data.experiment.scope.visitors.PrintFlatViewScopeVisitor.printMetrics(), edu.rice.cs.hpc.data.experiment.merge.MergeMetric.setMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedPercentVisitor.setPercent(), and edu.rice.cs.hpc.data.experiment.scope.visitors.PercentScopeVisitor.setPercentValue().

MetricValue [] edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValues (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope.getName (  )  [virtual]
TreeNode edu.rice.cs.hpc.data.experiment.scope.TreeNode.getParent (  )  [inherited]

Returns the parent node.

Returns:
The parent node; may be null if there are no parent nodes.

Definition at line 94 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.parent.

Referenced by edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getInputNode(), and edu.rice.cs.hpc.data.experiment.scope.Scope.getParentScope().

Scope edu.rice.cs.hpc.data.experiment.scope.Scope.getParentScope (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.scope.StatementRangeScope.getShortName (  ) 
String edu.rice.cs.hpc.data.experiment.scope.Scope.getSourceCitation (  )  [protected, inherited]
SourceFile edu.rice.cs.hpc.data.experiment.scope.Scope.getSourceFile (  )  [inherited]
Scope edu.rice.cs.hpc.data.experiment.scope.Scope.getSubscope ( int  index  )  [inherited]
int edu.rice.cs.hpc.data.experiment.scope.Scope.getSubscopeCount (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.scope.Scope.getToolTip (  )  [inherited]
Object edu.rice.cs.hpc.data.experiment.scope.TreeNode.getValue (  )  [inherited]

Returns the value held by this node.

Returns:
The value; may be anything.

Definition at line 103 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.value.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.getCCTIndex().

boolean edu.rice.cs.hpc.data.experiment.scope.TreeNode.hasChildren (  )  [inherited]

Returns whether the tree has any children.

Returns:
true if its array of children is not null and is non-empty; false otherwise.

Definition at line 114 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.children.

Referenced by edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.flatten(), and edu.rice.cs.hpc.viewer.scope.bottomup.CallerViewContentProvider.hasChildren().

static final int edu.rice.cs.hpc.data.experiment.scope.TreeNode.hashCode ( final Object  object  )  [static, inherited]

Provides a hash code for the object -- defending against null.

Parameters:
object The object for which a hash code is required.
Returns:
object.hashCode or 0 if object if null.

Definition at line 219 of file TreeNode.java.

int edu.rice.cs.hpc.data.experiment.scope.Scope.hashCode (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.scope.Scope.hasMetrics (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.scope.Scope.hasNonzeroMetrics (  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.incrementCounter (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.scope.Scope.isCounterPositif (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.scope.Scope.isCounterZero (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.scope.Scope.isExperimentHasMetrics (  )  [protected, inherited]
void edu.rice.cs.hpc.data.experiment.scope.TreeNode.remove ( int  index  )  [inherited]

Remove a child for a given index.

Parameters:
index : index of the scope to be removed

Definition at line 151 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.children.

void edu.rice.cs.hpc.data.experiment.scope.TreeNode.remove ( TreeNode  child  )  [inherited]

Remove a child.

The child hash code (which is the cct) has to be unique.
Otherwise, it will remove incorrect child.

Parameters:
child : the child to be removed

Definition at line 141 of file TreeNode.java.

References edu.rice.cs.hpc.data.experiment.scope.TreeNode.children.

Referenced by edu.rice.cs.hpc.data.experiment.Experiment.filter_finalize(), and edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.removeChild().

void edu.rice.cs.hpc.data.experiment.scope.Scope.safeCombine ( Scope  source,
MetricValuePropagationFilter  filter 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.setCounter ( int  counter  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.setCpid ( int  _cpid  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.setExperiment ( BaseExperiment  exp  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.setMetricValue ( int  index,
MetricValue  value 
) [inherited]
void edu.rice.cs.hpc.data.experiment.scope.Scope.setMetricValues ( MetricValue  values[]  )  [inherited]
void edu.rice.cs.hpc.data.experiment.scope.TreeNode.setParent ( final TreeNode  parent  )  [inherited]

Sets the parent for this node.

Parameters:
parent The parent node; may be null.

Definition at line 162 of file TreeNode.java.

Referenced by edu.rice.cs.hpc.data.experiment.scope.Scope.setParentScope().

void edu.rice.cs.hpc.data.experiment.scope.Scope.setParentScope ( Scope  parentScope  )  [inherited]
String edu.rice.cs.hpc.data.experiment.scope.Scope.toString (  )  [inherited]

Definition at line 276 of file Scope.java.

References edu.rice.cs.hpc.data.experiment.scope.Scope.getName().


Member Data Documentation

int edu.rice.cs.hpc.data.experiment.scope.Scope.idMax = 0 [static, protected, inherited]

The current maximum number of ID for all scopes.

Definition at line 62 of file Scope.java.

Definition at line 97 of file Scope.java.

Referenced by edu.rice.cs.hpc.viewer.util.Utilities.isFileReadable().

final int edu.rice.cs.hpc.data.experiment.scope.Scope.NO_LINE_NUMBER = -169 [static, inherited]

The value used to indicate "no line number".

Definition at line 55 of file Scope.java.

Definition at line 58 of file Scope.java.

Definition at line 59 of file Scope.java.

Definition at line 57 of file Scope.java.


The documentation for this class was generated from the following file:

Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1