ROSE  0.11.54.0
Public Member Functions | Protected Attributes | List of all members
MetricAttribute Class Reference

Description

Attribute corresponding to a metric.

A metric attribute represents a numeric value obtained by either dynamic analysis (gprof or hpct) or static analysis (for example number of flop operations in a function) It MetricAttribute can be a raw (observed), or a propagated (derived) count It containes no name-string, because the attribute is stored in an AttributeMechanism-map, where the name is the key.

Definition at line 412 of file AstAttributeMechanism.h.

#include <AstAttributeMechanism.h>

Inheritance diagram for MetricAttribute:
Inheritance graph
[legend]
Collaboration diagram for MetricAttribute:
Collaboration graph
[legend]

Public Member Functions

 MetricAttribute (double value, bool is_derived=false)
 
virtual AstAttributecopy () const
 Virtual copy constructor. More...
 
virtual std::string attribute_class_name () const
 Attribute class name. More...
 
virtual bool isDerived () const
 
virtual double getValue () const
 
virtual void setValue (double newVal)
 
virtual std::string toString ()
 Convert an attribute to a string. More...
 
virtual int packed_size ()
 Packing support.
 
virtual char * packed_data ()
 Packing support.
 
virtual void unpacked_data (int size, char *data)
 Packing support.
 
MetricAttributeoperator+= (const MetricAttribute &other)
 
MetricAttributeoperator-= (const MetricAttribute &other)
 
MetricAttributeoperator*= (const MetricAttribute &other)
 
MetricAttributeoperator/= (const MetricAttribute &other)
 
- Public Member Functions inherited from AstAttribute
virtual OwnershipPolicy getOwnershipPolicy () const
 Who owns this attribute. More...
 
virtual AstAttributeconstructor () const
 Virtual default constructor. More...
 
virtual AstAttributecopy ()
 
virtual bool commentOutNodeInGraph ()
 Eliminate IR nodes in DOT graphs. More...
 
virtual std::string additionalNodeOptions ()
 DOT support.
 
virtual std::vector< AttributeEdgeInfoadditionalEdgeInfo ()
 DOT support.
 
virtual std::vector< AttributeNodeInfoadditionalNodeInfo ()
 DOT support.
 

Protected Attributes

bool is_derived_
 
double value_
 

Additional Inherited Members

- Public Types inherited from AstAttribute
enum  OwnershipPolicy {
  CONTAINER_OWNERSHIP,
  NO_OWNERSHIP,
  CUSTOM_OWNERSHIP,
  UNKNOWN_OWNERSHIP
}
 Who owns this attribute. More...
 

Member Function Documentation

virtual AstAttribute* MetricAttribute::copy ( ) const
virtual

Virtual copy constructor.

Copy-constructs a new object on the heap and returns its pointer. All subclasses must implement this in order to instantiate the correct dynamic type, although many don't. If this copy method returns a null pointer (like the base implementation) then the attribute is not copied as part of copying its container. E.g., an attribute stored in an AST will not be copied when the AST is copied if that attribute is directly derived from AstAttribute and fails to implement copy. If a subclass fails to implement copy and inherits from a class that does implement a copy that returns non-null, then the copied attribute will have an incorrect dynamic type.

It would be nice if we could make this pure virtual, but unfortunately ROSETTA-generated code fails to compile because it generates an instantiation of this interface (whether or not that code is ever executed is unkown). [Robb Matzke 2015-11-10]

Reimplemented from AstAttribute.

virtual std::string MetricAttribute::attribute_class_name ( ) const
virtual

Attribute class name.

Returns the name of the dynamic type. All subclasses must implement this in order to return the correct type name, although many don't. If a subclass fails to implement this then it will return an incorrect class name.

It would be nice if this could be pure virtual, but unfortunately ROSETTA-generated code fails to compile because it generates an instantiation of this interface (whether or not that code is ever executed is unknown). [Robb Matzke 2015-11-10]

Reimplemented from AstAttribute.

virtual std::string MetricAttribute::toString ( )
virtual

Convert an attribute to a string.

This is used by other components to print the value of an attribute. For example the pdf generation calls this function to print the value of an attribute in the pdf file. The default implementation is to return the attribute address in the heap as a string.

Reimplemented from AstAttribute.


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