geopm  3.1.1.dev214+gba4f9f6d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::Tracer Class Referenceabstract

Abstract base class for the Tracer object defines the interface. More...

#include <Tracer.hpp>

Inheritance diagram for geopm::Tracer:
Inheritance graph
[legend]

Public Member Functions

 Tracer ()=default
 
virtual ~Tracer ()=default
 
virtual void columns (const std::vector< std::string > &agent_cols, const std::vector< std::function< std::string(double)> > &agent_formats)=0
 Set up default columns and add columns to be. More...
 
virtual void update (const std::vector< double > &agent_signals)=0
 Update the trace with telemetry samples and region info. The Tracer samples values for default and environment columns and the remaining signal values are provided by the Agent. More...
 
virtual void flush (void)=0
 Write the remaining trace data to the file and stop tracing. More...
 

Detailed Description

Abstract base class for the Tracer object defines the interface.

Constructor & Destructor Documentation

◆ Tracer()

geopm::Tracer::Tracer ( )
default

◆ ~Tracer()

virtual geopm::Tracer::~Tracer ( )
virtualdefault

Member Function Documentation

◆ columns()

virtual void geopm::Tracer::columns ( const std::vector< std::string > &  agent_cols,
const std::vector< std::function< std::string(double)> > &  agent_formats 
)
pure virtual

Set up default columns and add columns to be.

Implemented in geopm::TracerImp.

◆ flush()

virtual void geopm::Tracer::flush ( void  )
pure virtual

Write the remaining trace data to the file and stop tracing.

Implemented in geopm::TracerImp.

◆ update()

virtual void geopm::Tracer::update ( const std::vector< double > &  agent_signals)
pure virtual

Update the trace with telemetry samples and region info. The Tracer samples values for default and environment columns and the remaining signal values are provided by the Agent.

Parameters
[in]agent_signalsValues for signals provided by the agent.

Implemented in geopm::TracerImp.


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