HPCToolkit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Analysis::ArgsHPCProf Class Referenceabstract

#include <ArgsHPCProf.hpp>

Inheritance diagram for Analysis::ArgsHPCProf:
Inheritance graph
[legend]
Collaboration diagram for Analysis::ArgsHPCProf:
Collaboration graph
[legend]

Public Types

enum  MetricFlg { MetricFlg_NULL = 0, MetricFlg_Thread = (1 << 1), MetricFlg_StatsSum = (1 << 2), MetricFlg_StatsAll = (1 << 3) }
 
enum  TxtSum {
  TxtSum_NULL = 0, TxtSum_fPgm = 0x00000001, TxtSum_fLM = 0x00000010, TxtSum_fFile = 0x00000100,
  TxtSum_fProc = 0x00001000, TxtSum_fLoop = 0x00010000, TxtSum_fStmt = 0x00100000, TxtSum_ALL
}
 

Public Member Functions

 ArgsHPCProf ()
 
virtual ~ArgsHPCProf ()
 
virtual void parse (int argc, const char *const argv[])
 
void printVersion (std::ostream &os) const
 
void printUsage (std::ostream &os) const
 
void printError (std::ostream &os, const char *msg) const
 
void printError (std::ostream &os, const std::string &msg) const
 
virtual void dump (std::ostream &os=std::cerr) const
 
virtual const std::string getCmd () const =0
 
virtual std::string toString () const
 
void ddump () const
 
void normalizeSearchPaths ()
 
void makeDatabaseDir ()
 
std::string searchPathStr () const
 

Static Public Member Functions

static bool MetricFlg_isSet (uint flags, MetricFlg x)
 
static void MetricFlg_set (uint &flags, MetricFlg x)
 
static void MetricFlg_clear (uint &flags, MetricFlg x)
 
static bool MetricFlg_isThread (uint flags)
 
static bool MetricFlg_isSum (uint flags)
 

Public Attributes

std::string agent
 
std::string title
 
PathTupleVec searchPathTpls
 
std::vector< std::string > structureFiles
 
std::vector< std::string > groupFiles
 
std::vector< std::string > replaceInPath
 
std::vector< std::string > replaceOutPath
 
std::vector< std::string > profileFiles
 
bool doNormalizeTy
 
uint prof_metrics
 
bool profflat_computeFinalMetricValues
 
std::string out_db_experiment
 
std::string out_db_csv
 
std::string db_dir
 
bool db_copySrcFiles
 
std::string out_db_config
 
bool db_makeMetricDB
 
bool db_addStructId
 
std::string out_txt
 
int txt_summary
 
bool txt_srcAnnotation
 
std::vector< std::string > txt_srcFileGlobs
 
bool remove_redundancy
 

Protected Member Functions

bool parseArg_norm (const std::string &value, const char *errTag)
 
void parseArg_metric (const std::string &value, const char *errTag)
 

Static Protected Member Functions

static std::string makeDBDirName (const std::string &profileArg)
 

Protected Attributes

CmdLineParser parser
 

Static Protected Attributes

static CmdLineParser::OptArgDesc optArgs []
 

Detailed Description

Definition at line 83 of file ArgsHPCProf.hpp.

Member Enumeration Documentation

◆ MetricFlg

enum Analysis::Args::MetricFlg
inherited
Enumerator
MetricFlg_NULL 
MetricFlg_Thread 
MetricFlg_StatsSum 
MetricFlg_StatsAll 

Definition at line 146 of file Args.hpp.

◆ TxtSum

enum Analysis::Args::TxtSum
inherited
Enumerator
TxtSum_NULL 
TxtSum_fPgm 
TxtSum_fLM 
TxtSum_fFile 
TxtSum_fProc 
TxtSum_fLoop 
TxtSum_fStmt 
TxtSum_ALL 

Definition at line 215 of file Args.hpp.

Constructor & Destructor Documentation

◆ ArgsHPCProf()

Analysis::ArgsHPCProf::ArgsHPCProf ( )

Definition at line 233 of file ArgsHPCProf.cpp.

Here is the call graph for this function:

◆ ~ArgsHPCProf()

Analysis::ArgsHPCProf::~ArgsHPCProf ( )
virtual

Definition at line 245 of file ArgsHPCProf.cpp.

Member Function Documentation

◆ ddump()

void Args::ddump ( ) const
inherited

Definition at line 154 of file Args.cpp.

Here is the call graph for this function:

◆ dump()

void Analysis::ArgsHPCProf::dump ( std::ostream &  os = std::cerr) const
virtual

Reimplemented from Analysis::Args.

Reimplemented in Args, Args, Args, Args, Args, and Args.

Definition at line 447 of file ArgsHPCProf.cpp.

Here is the call graph for this function:

◆ getCmd()

virtual const std::string Analysis::ArgsHPCProf::getCmd ( ) const
pure virtual

Implemented in Args, Args, Args, Args, Args, Args, Args, and Args.

Here is the caller graph for this function:

◆ makeDatabaseDir()

void Args::makeDatabaseDir ( )
inherited

Definition at line 203 of file Args.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeDBDirName()

std::string Analysis::ArgsHPCProf::makeDBDirName ( const std::string &  profileArg)
staticprotected

Definition at line 499 of file ArgsHPCProf.cpp.

Here is the caller graph for this function:

◆ MetricFlg_clear()

static void Analysis::Args::MetricFlg_clear ( uint &  flags,
MetricFlg  x 
)
inlinestaticinherited

Definition at line 162 of file Args.hpp.

Here is the caller graph for this function:

◆ MetricFlg_isSet()

static bool Analysis::Args::MetricFlg_isSet ( uint  flags,
MetricFlg  x 
)
inlinestaticinherited

Definition at line 154 of file Args.hpp.

Here is the caller graph for this function:

◆ MetricFlg_isSum()

static bool Analysis::Args::MetricFlg_isSum ( uint  flags)
inlinestaticinherited

Definition at line 170 of file Args.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MetricFlg_isThread()

static bool Analysis::Args::MetricFlg_isThread ( uint  flags)
inlinestaticinherited

Definition at line 166 of file Args.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MetricFlg_set()

static void Analysis::Args::MetricFlg_set ( uint &  flags,
MetricFlg  x 
)
inlinestaticinherited

Definition at line 158 of file Args.hpp.

Here is the caller graph for this function:

◆ normalizeSearchPaths()

void Args::normalizeSearchPaths ( )
inherited

Definition at line 169 of file Args.cpp.

◆ parse()

void Analysis::ArgsHPCProf::parse ( int  argc,
const char *const  argv[] 
)
virtual

Reimplemented in Args, Args, Args, Args, Args, Args, and Args.

Definition at line 281 of file ArgsHPCProf.cpp.

Here is the call graph for this function:

◆ parseArg_metric()

void Analysis::ArgsHPCProf::parseArg_metric ( const std::string &  value,
const char *  errTag 
)
protected

Definition at line 473 of file ArgsHPCProf.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parseArg_norm()

bool Analysis::ArgsHPCProf::parseArg_norm ( const std::string &  value,
const char *  errTag 
)
protected

Definition at line 457 of file ArgsHPCProf.cpp.

Here is the caller graph for this function:

◆ printError() [1/2]

void Analysis::ArgsHPCProf::printError ( std::ostream &  os,
const char *  msg 
) const

Definition at line 266 of file ArgsHPCProf.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ printError() [2/2]

void Analysis::ArgsHPCProf::printError ( std::ostream &  os,
const std::string &  msg 
) const

Definition at line 274 of file ArgsHPCProf.cpp.

Here is the call graph for this function:

◆ printUsage()

void Analysis::ArgsHPCProf::printUsage ( std::ostream &  os) const

Definition at line 258 of file ArgsHPCProf.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ printVersion()

void Analysis::ArgsHPCProf::printVersion ( std::ostream &  os) const

Definition at line 251 of file ArgsHPCProf.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ searchPathStr()

std::string Args::searchPathStr ( ) const
inherited

Definition at line 214 of file Args.cpp.

◆ toString()

string Args::toString ( ) const
virtualinherited

Definition at line 135 of file Args.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ agent

std::string Analysis::Args::agent
inherited

Definition at line 114 of file Args.hpp.

◆ db_addStructId

bool Analysis::Args::db_addStructId
inherited

Definition at line 205 of file Args.hpp.

◆ db_copySrcFiles

bool Analysis::Args::db_copySrcFiles
inherited

Definition at line 200 of file Args.hpp.

◆ db_dir

std::string Analysis::Args::db_dir
inherited

Definition at line 199 of file Args.hpp.

◆ db_makeMetricDB

bool Analysis::Args::db_makeMetricDB
inherited

Definition at line 204 of file Args.hpp.

◆ doNormalizeTy

bool Analysis::Args::doNormalizeTy
inherited

Definition at line 140 of file Args.hpp.

◆ groupFiles

std::vector<std::string> Analysis::Args::groupFiles
inherited

Definition at line 131 of file Args.hpp.

◆ optArgs

CmdLineParser::OptArgDesc Analysis::ArgsHPCProf::optArgs
staticprotected

Definition at line 129 of file ArgsHPCProf.hpp.

◆ out_db_config

std::string Analysis::Args::out_db_config
inherited

Definition at line 202 of file Args.hpp.

◆ out_db_csv

std::string Analysis::Args::out_db_csv
inherited

Definition at line 197 of file Args.hpp.

◆ out_db_experiment

std::string Analysis::Args::out_db_experiment
inherited

Definition at line 196 of file Args.hpp.

◆ out_txt

std::string Analysis::Args::out_txt
inherited

Definition at line 213 of file Args.hpp.

◆ parser

CmdLineParser Analysis::ArgsHPCProf::parser
protected

Definition at line 130 of file ArgsHPCProf.hpp.

◆ prof_metrics

uint Analysis::Args::prof_metrics
inherited

Definition at line 176 of file Args.hpp.

◆ profflat_computeFinalMetricValues

bool Analysis::Args::profflat_computeFinalMetricValues
inherited

Definition at line 182 of file Args.hpp.

◆ profileFiles

std::vector<std::string> Analysis::Args::profileFiles
inherited

Definition at line 138 of file Args.hpp.

◆ remove_redundancy

bool Analysis::Args::remove_redundancy
inherited

Definition at line 241 of file Args.hpp.

◆ replaceInPath

std::vector<std::string> Analysis::Args::replaceInPath
inherited

Definition at line 134 of file Args.hpp.

◆ replaceOutPath

std::vector<std::string> Analysis::Args::replaceOutPath
inherited

Definition at line 135 of file Args.hpp.

◆ searchPathTpls

PathTupleVec Analysis::Args::searchPathTpls
inherited

Definition at line 125 of file Args.hpp.

◆ structureFiles

std::vector<std::string> Analysis::Args::structureFiles
inherited

Definition at line 128 of file Args.hpp.

◆ title

std::string Analysis::Args::title
inherited

Definition at line 121 of file Args.hpp.

◆ txt_srcAnnotation

bool Analysis::Args::txt_srcAnnotation
inherited

Definition at line 233 of file Args.hpp.

◆ txt_srcFileGlobs

std::vector<std::string> Analysis::Args::txt_srcFileGlobs
inherited

Definition at line 234 of file Args.hpp.

◆ txt_summary

int Analysis::Args::txt_summary
inherited

Definition at line 231 of file Args.hpp.

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