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

Inheritance diagram for edu.rice.cs.hpc.data.experiment.metric.MetricRaw:
Inheritance graph
[legend]
Collaboration diagram for edu.rice.cs.hpc.data.experiment.metric.MetricRaw:
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

 MetricRaw (String sID, String sDisplayName, boolean displayed, String format, AnnotationType annotationType, int index)
 MetricRaw (int id, String title, String db_pattern, int db_num, int metrics)
String getGlob ()
int getRawID ()
int getSize ()
int getID ()
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 ()

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 Attributes

int ID
String db_glob
int db_id
int num_metrics

Detailed Description

Definition at line 10 of file MetricRaw.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.MetricRaw.MetricRaw ( String  sID,
String  sDisplayName,
boolean  displayed,
String  format,
AnnotationType  annotationType,
int  index 
)
edu.rice.cs.hpc.data.experiment.metric.MetricRaw.MetricRaw ( int  id,
String  title,
String  db_pattern,
int  db_num,
int  metrics 
)

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.MetricRaw.duplicate (  )  [virtual]
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]
String edu.rice.cs.hpc.data.experiment.metric.MetricRaw.getGlob (  ) 
int edu.rice.cs.hpc.data.experiment.metric.MetricRaw.getID (  ) 
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]
int edu.rice.cs.hpc.data.experiment.metric.MetricRaw.getRawID (  ) 
double edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getSamplePeriod (  )  [inherited]
String edu.rice.cs.hpc.data.experiment.metric.BaseMetric.getShortName (  )  [inherited]
int edu.rice.cs.hpc.data.experiment.metric.MetricRaw.getSize (  ) 
MetricValue edu.rice.cs.hpc.data.experiment.metric.MetricRaw.getValue ( Scope  s  )  [virtual]

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

Definition at line 72 of file MetricRaw.java.

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