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

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

List of all members.

Public Types

enum  AnnotationType { NONE, PERCENT, PROCESS }
 

Valid types of Annotations to be used with metric values.

More...

Public Member Functions

 DerivedMetric (Experiment experiment, Expression e, String sName, String sID, int index, AnnotationType annotationType, MetricType objType)
void setExpression (Expression expr)
Double getDoubleValue (Scope scope)
 Computing the value of the derived metric.
MetricValue getValue (Scope scope)
 Overloading method to compute the value of the derived metric of a scope Return a MetricValue.
Expression getFormula ()
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 ()

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

double getAggregateMetrics (RootScope scopeRoot)
 Compute the general aggregate metric for cct, caller tree and flat tree.

Private Attributes

Expression expression
double dRootValue = 0.0
ExtFuncMap fctMap
MetricVarMap varMap
Experiment experiment

Detailed Description

Author:
la5

Definition at line 16 of file DerivedMetric.java.


Member Enumeration Documentation

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.DerivedMetric.DerivedMetric ( Experiment  experiment,
Expression  e,
String  sName,
String  sID,
int  index,
AnnotationType  annotationType,
MetricType  objType 
)

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.DerivedMetric.duplicate (  )  [virtual]
double edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getAggregateMetrics ( RootScope  scopeRoot  )  [private]

Compute the general aggregate metric for cct, caller tree and flat tree.

Parameters:
scopeRoot 
Returns:
the aggregate value

Definition at line 98 of file DerivedMetric.java.

References edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getDoubleValue().

Referenced by edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.DerivedMetric(), and edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.setExpression().

AnnotationType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getAnnotationType (  )  [inherited]
boolean edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayed (  )  [inherited]
IMetricValueFormat edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayFormat (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getDisplayName (  )  [inherited]
Double edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getDoubleValue ( Scope  scope  ) 
Expression edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getFormula (  ) 
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getIndex (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue ( MetricValue  mv_  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricTextValue ( Scope  scope  )  [inherited]
MetricType edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getMetricType (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getNativeName (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getPartner (  )  [inherited]
double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getSamplePeriod (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getShortName (  )  [inherited]
MetricValue edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.getValue ( Scope  scope  )  [virtual]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setAnnotationType ( AnnotationType  annType  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayed ( boolean  d  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayFormat ( IMetricValueFormat  format  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setDisplayName ( String  name  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.DerivedMetric.setExpression ( Expression  expr  ) 
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setIndex ( int  index  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setMetricType ( MetricType  objType  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setPartner ( int  ei  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setSamplePeriod ( String  s  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setShortName ( String  newName  )  [inherited]
void edu.rice.cs.hpc.data.experiment.metric.BaseMetric.setUnit ( String  sUnit  )  [inherited]

Member Data Documentation

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


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

Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1