edu.rice.cs.hpc.data.experiment.metric.Metric Class Reference

A metric and its data in an HPCView experiment. More...

Inheritance diagram for edu.rice.cs.hpc.data.experiment.metric.Metric:

Collaboration diagram for edu.rice.cs.hpc.data.experiment.metric.Metric:

Public Types
enum	AnnotationType { NONE, PERCENT, PROCESS }
	Valid types of Annotations to be used with metric values. More...
Public Member Functions
	Metric (String shortName, String nativeName, String displayName, boolean displayed, String format, AnnotationType annotationType, String samplePeriod, int index, MetricType metricType, int partnerIndex)
	Construct a metric using a "String" sample period.
MetricValue	getValue (Scope s)
BaseMetric	duplicate ()
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 ()
Static Public Attributes
static final int	NO_PARTNER_INDEX = -1
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

Detailed Description

A metric and its data in an HPCView experiment.

Definition at line 34 of file Metric.java.

Member Enumeration Documentation

enum edu::rice::cs::hpc::data::experiment::metric::BaseMetric::AnnotationType [inherited]

Valid types of Annotations to be used with metric values.

Enumerator:

NONE
PERCENT
PROCESS

Definition at line 18 of file BaseMetric.java.

Constructor & Destructor Documentation

edu.rice.cs.hpc.data.experiment.metric.Metric.Metric	(	String	shortName,
		String	nativeName,
		String	displayName,
		boolean	displayed,
		String	format,
		AnnotationType	annotationType,
		String	samplePeriod,
		int	index,
		MetricType	metricType,
		int	partnerIndex
	)

Construct a metric using a "String" sample period.

Parameters:

	shortName
	nativeName
	displayName
	displayed
	format
	annotationType
	sampleperiod
	metricType
	partnerIndex

Definition at line 63 of file Metric.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.metric.Metric.duplicate().

Member Function Documentation

double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.convertSamplePeriode ( String sPeriod ) [protected, inherited]

convert the input sample period into a double, depending of the unit

Parameters:

sPeriod

Returns:

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().

BaseMetric edu.rice.cs.hpc.data.experiment.metric.Metric.duplicate ( ) [virtual]

Implements edu.rice.cs.hpc.data.experiment.metric.BaseMetric.

Definition at line 87 of file Metric.java.

AnnotationType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getAnnotationType ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Definition at line 167 of file BaseMetric.java.

References edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayName.

int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getIndex ( ) [inherited]

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_ ) [inherited]

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 ) [inherited]

Return the text to display based on the value of the scope.

Parameters:

scope

Returns:

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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().

MetricValue edu.rice.cs.hpc.data.experiment.metric.Metric.getValue ( Scope s ) [virtual]

Implements edu.rice.cs.hpc.data.experiment.metric.BaseMetric.

Definition at line 79 of file Metric.java.

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

void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setAnnotationType ( AnnotationType annType ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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 ) [inherited]

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().

Member Data Documentation

AnnotationType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.annotationType = AnnotationType.NONE [protected, inherited]

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, inherited]

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().

IMetricValueFormat edu.rice.cs.hpc.data.experiment.metric.BaseMetric.displayFormat [protected, inherited]

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, inherited]

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().

int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.index [protected, inherited]

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().

MetricType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.metricType [protected, inherited]

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, inherited]

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().

final int edu.rice.cs.hpc.data.experiment.metric.Metric.NO_PARTNER_INDEX = -1 [static]

Definition at line 37 of file Metric.java.

int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.partner_index [protected, inherited]

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, inherited]

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, inherited]

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().

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

edu.rice.cs.hpc.data/src/edu/rice/cs/hpc/data/experiment/metric/Metric.java

edu.rice.cs.hpc.data.experiment.metric.Metric Class Reference

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation