Public Types | |
enum | AnnotationType { NONE, PERCENT, PROCESS } |
Valid types of Annotations to be used with metric values. More... | |
Public Member Functions | |
BaseMetric (String sID, String sDisplayName, boolean displayed, String format, AnnotationType annotationType, int index, int partner_index, MetricType type) | |
void | setIndex (int index) |
int | getIndex () |
int | getPartner () |
void | setPartner (int ei) |
String | getShortName () |
void | setShortName (String newName) |
String | getNativeName () |
String | getDisplayName () |
void | setDisplayName (String name) |
boolean | getDisplayed () |
void | setDisplayed (boolean d) |
AnnotationType | getAnnotationType () |
void | setAnnotationType (AnnotationType annType) |
String | getMetricTextValue (Scope scope) |
Return the text to display based on the value of the scope. | |
String | getMetricTextValue (MetricValue mv_) |
void | setDisplayFormat (IMetricValueFormat format) |
IMetricValueFormat | getDisplayFormat () |
MetricType | getMetricType () |
void | setMetricType (MetricType objType) |
void | setSamplePeriod (String s) |
void | setUnit (String sUnit) |
double | getSamplePeriod () |
abstract MetricValue | getValue (Scope s) |
abstract BaseMetric | duplicate () |
Protected Member Functions | |
double | convertSamplePeriode (String sPeriod) |
convert the input sample period into a double, depending of the unit | |
Protected Attributes | |
String | shortName |
The short name of this metric, used within an experiment's XML file. | |
String | nativeName |
The native (target OS toolset) name of this metric. | |
String | displayName |
The user-visible name of this metric. | |
boolean | displayed |
Whether this metric should be displayed. | |
AnnotationType | annotationType = AnnotationType.NONE |
The type of annotation that should be displayed with this metric (percent or process number). | |
int | index |
The index of this metric in its experiment's metric list. | |
int | partner_index |
IMetricValueFormat | displayFormat |
The display format to be used for this metric. | |
MetricType | metricType |
double | sampleperiod |
Private Member Functions | |
boolean | isUnitEvent () |
Verify if the unit is an event or not. | |
Private Attributes | |
char | unit |
final String | EMPTY_SUFFIX = " " |
Definition at line 12 of file BaseMetric.java.
Valid types of Annotations to be used with metric values.
Definition at line 18 of file BaseMetric.java.
edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric | ( | String | sID, | |
String | sDisplayName, | |||
boolean | displayed, | |||
String | format, | |||
AnnotationType | annotationType, | |||
int | index, | |||
int | partner_index, | |||
MetricType | type | |||
) |
Definition at line 64 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayFormat, edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayName, edu.rice.cs.hpc.data.experiment.metric.BaseMetric.EMPTY_SUFFIX, edu.rice.cs.hpc.data.experiment.metric.BaseMetric.metricType, edu.rice.cs.hpc.data.experiment.metric.BaseMetric.shortName, and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.unit.
double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.convertSamplePeriode | ( | String | sPeriod | ) | [protected] |
convert the input sample period into a double, depending of the unit
sPeriod |
Definition at line 340 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.isUnitEvent().
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.Metric(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setSamplePeriod().
abstract BaseMetric edu.rice.cs.hpc.data.experiment.metric.BaseMetric.duplicate | ( | ) | [pure virtual] |
Implemented in edu.rice.cs.hpc.data.experiment.metric.AggregateMetric, edu.rice.cs.hpc.data.experiment.metric.DerivedMetric, edu.rice.cs.hpc.data.experiment.metric.Metric, and edu.rice.cs.hpc.data.experiment.metric.MetricRaw.
Referenced by edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.buildMetricList().
AnnotationType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getAnnotationType | ( | ) |
Definition at line 201 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.annotationType.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.createDialogArea(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getValue(), and edu.rice.cs.hpc.data.experiment.xml.PrintFileXML.printAnnotationType().
boolean edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayed | ( | ) |
Definition at line 184 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayed.
Referenced by edu.rice.cs.hpc.viewer.scope.BaseScopeView.initTableColumns(), and edu.rice.cs.hpc.data.experiment.xml.PrintFileXML.printMetricTable().
IMetricValueFormat edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayFormat | ( | ) |
Definition at line 258 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayFormat.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.createDialogArea(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue(), and edu.rice.cs.hpc.data.experiment.metric.TestMetricFormat.main().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayName | ( | ) |
Definition at line 167 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayName.
Referenced by edu.rice.cs.hpc.viewer.scope.ScopeTreeViewer.addTreeColumn(), edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.createDialogArea(), edu.rice.cs.hpc.viewer.metric.MetricPropertyDialog.createInput(), edu.rice.cs.hpc.viewer.metric.MetricPropertyDialog.doAction(), edu.rice.cs.hpc.viewer.graph.GraphEditorInput.getName(), edu.rice.cs.hpc.viewer.scope.BaseScopeView.initTableColumns(), edu.rice.cs.hpc.viewer.graph.GraphEditorHisto.plotData(), edu.rice.cs.hpc.viewer.graph.GraphEditor.plotData(), edu.rice.cs.hpc.data.experiment.xml.PrintFileXML.printMetricTable(), edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.setMetricCombinedName(), and edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.setMetrics().
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getIndex | ( | ) |
Definition at line 114 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.index.
Referenced by edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.buildMetricList(), edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.do_M(), edu.rice.cs.hpc.data.experiment.scope.Scope.getMetricValue(), edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetrics(), edu.rice.cs.hpc.data.experiment.scope.visitors.PrintFlatViewScopeVisitor.printMetrics(), and edu.rice.cs.hpc.data.experiment.xml.PrintFileXML.printMetricTable().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue | ( | MetricValue | mv_ | ) |
Definition at line 225 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.IMetricValueFormat.format(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayFormat(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.isAvailable(), edu.rice.cs.hpc.data.experiment.metric.MetricValue.NONE, and edu.rice.cs.hpc.data.experiment.metric.MetricValue.value.
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue | ( | Scope | scope | ) |
Return the text to display based on the value of the scope.
scope |
Definition at line 216 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getValue().
Referenced by edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent(), edu.rice.cs.hpc.viewer.metric.BaseMetricLabelProvider.getText(), edu.rice.cs.hpc.viewer.scope.ScopeViewActionsGUI.insertParentNode(), and edu.rice.cs.hpc.viewer.scope.ScopeTreeViewer.refreshColumnTitle().
MetricType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricType | ( | ) |
Definition at line 266 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.metricType.
Referenced by edu.rice.cs.hpc.data.experiment.Experiment.copyMetricsToPartner(), edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.do_M(), edu.rice.cs.hpc.data.experiment.scope.filters.InclusiveOnlyMetricPropagationFilter.doPropagation(), edu.rice.cs.hpc.data.experiment.scope.filters.ExclusiveOnlyMetricPropagationFilter.doPropagation(), edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.end_ProfileData(), and edu.rice.cs.hpc.data.experiment.xml.PrintFileXML.getMetricType().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getNativeName | ( | ) |
Definition at line 159 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.nativeName.
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getPartner | ( | ) |
Definition at line 124 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.partner_index.
Referenced by edu.rice.cs.hpc.data.experiment.scope.visitors.FilterScopeVisitor.mergeMetrics().
double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getSamplePeriod | ( | ) |
Definition at line 301 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.sampleperiod.
Referenced by edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.do_M().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getShortName | ( | ) |
Definition at line 142 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.shortName.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.doAction(), edu.rice.cs.hpc.data.experiment.BaseExperimentWithMetrics.getMetric(), edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.insertMetricToFormula(), and edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.setMetrics().
abstract MetricValue edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getValue | ( | Scope | s | ) | [pure virtual] |
Implemented in edu.rice.cs.hpc.data.experiment.metric.AggregateMetric, edu.rice.cs.hpc.data.experiment.metric.DerivedMetric, edu.rice.cs.hpc.data.experiment.metric.Metric, and edu.rice.cs.hpc.data.experiment.metric.MetricRaw.
Referenced by edu.rice.cs.hpc.viewer.scope.ColumnViewerSorter.doCompare(), edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getHotCallPath(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue(), edu.rice.cs.hpc.data.experiment.metric.MetricVarMap.getValue(), edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedMetricVisitor.up(), and edu.rice.cs.hpc.data.experiment.scope.visitors.DerivedMetricVisitor.visit().
boolean edu.rice.cs.hpc.data.experiment.metric.BaseMetric.isUnitEvent | ( | ) | [private] |
Verify if the unit is an event or not.
Definition at line 331 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.unit.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.convertSamplePeriode(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setUnit().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setAnnotationType | ( | AnnotationType | annType | ) |
Definition at line 206 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.annotationType.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.doAction().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayed | ( | boolean | d | ) |
Definition at line 193 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayed.
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayFormat | ( | IMetricValueFormat | format | ) |
Definition at line 250 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayFormat.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.doAction().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayName | ( | String | name | ) |
Definition at line 176 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayName.
Referenced by edu.rice.cs.hpc.viewer.metric.ExtDerivedMetricDlg.doAction(), edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.setMetricCombinedName(), and edu.rice.cs.hpc.viewer.metric.MetricPropertyDialog.updateMetricName().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setIndex | ( | int | index | ) |
Definition at line 105 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.buildMetricList(), and edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.end_ProfileData().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setMetricType | ( | MetricType | objType | ) |
Definition at line 275 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.metricType.
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setPartner | ( | int | ei | ) |
Definition at line 129 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.partner_index.
Referenced by edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.end_ProfileData().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setSamplePeriod | ( | String | s | ) |
Definition at line 283 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.convertSamplePeriode(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.sampleperiod.
Referenced by edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.do_NV().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setShortName | ( | String | newName | ) |
Definition at line 151 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.shortName.
Referenced by edu.rice.cs.hpc.data.experiment.merge.ExperimentMerger.buildMetricList(), and edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.end_ProfileData().
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setUnit | ( | String | sUnit | ) |
Definition at line 291 of file BaseMetric.java.
References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.isUnitEvent(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.sampleperiod, and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.unit.
Referenced by edu.rice.cs.hpc.data.experiment.xml.ExperimentBuilder2.do_NV().
AnnotationType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.annotationType = AnnotationType.NONE [protected] |
The type of annotation that should be displayed with this metric (percent or process number).
Definition at line 33 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getAnnotationType(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setAnnotationType().
boolean edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayed [protected] |
Whether this metric should be displayed.
Definition at line 30 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayed(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayed().
The display format to be used for this metric.
Definition at line 41 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayFormat(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayFormat().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayName [protected] |
The user-visible name of this metric.
Definition at line 27 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric(), edu.rice.cs.hpc.data.experiment.metric.MetricRaw.duplicate(), edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayName(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayName().
final String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.EMPTY_SUFFIX = " " [private] |
Definition at line 49 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric().
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.index [protected] |
The index of this metric in its experiment's metric list.
Definition at line 36 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.combine(), edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getIndex(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.getValue(), and edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.setScopeValue().
Definition at line 43 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric(), edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricType(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setMetricType().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.nativeName [protected] |
The native (target OS toolset) name of this metric.
Definition at line 24 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getNativeName().
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.partner_index [protected] |
Definition at line 38 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getPartner(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setPartner().
double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.sampleperiod [protected] |
Definition at line 45 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getSamplePeriod(), edu.rice.cs.hpc.data.experiment.metric.Metric.Metric(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setSamplePeriod(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setUnit().
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.shortName [protected] |
The short name of this metric, used within an experiment's XML file.
Definition at line 18 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric(), edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.AggregateMetric.duplicate(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getShortName(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setShortName().
char edu.rice.cs.hpc.data.experiment.metric.BaseMetric.unit [private] |
Definition at line 47 of file BaseMetric.java.
Referenced by edu.rice.cs.hpc.data.experiment.metric.BaseMetric.BaseMetric(), edu.rice.cs.hpc.data.experiment.metric.BaseMetric.isUnitEvent(), and edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setUnit().