souffle  2.0.2-371-g6315b36
Public Member Functions | Protected Attributes | Friends
souffle::ram::analysis::Analysis Class Referenceabstract

Abstract class for a RAM Analysis. More...

#include <Analysis.h>

Inheritance diagram for souffle::ram::analysis::Analysis:
Inheritance graph
Collaboration diagram for souffle::ram::analysis::Analysis:
Collaboration graph

Public Member Functions

 Analysis (const char *id)
 
virtual const std::string & getName () const
 get name of the analysis More...
 
virtual void print (std::ostream &) const
 Print the analysis result in HTML format. More...
 
virtual void run (const TranslationUnit &translationUnit)=0
 Run analysis for a RAM translation unit. More...
 
virtual ~Analysis ()=default
 

Protected Attributes

std::string identifier
 name of analysis instance More...
 

Friends

std::ostream & operator<< (std::ostream &out, const Analysis &other)
 define output stream operator More...
 

Detailed Description

Abstract class for a RAM Analysis.

Definition at line 38 of file Analysis.h.

Constructor & Destructor Documentation

◆ Analysis()

souffle::ram::analysis::Analysis::Analysis ( const char *  id)
inline

Definition at line 40 of file Analysis.h.

◆ ~Analysis()

virtual souffle::ram::analysis::Analysis::~Analysis ( )
virtualdefault

Member Function Documentation

◆ getName()

virtual const std::string& souffle::ram::analysis::Analysis::getName ( ) const
inlinevirtual

get name of the analysis

Definition at line 44 of file Analysis.h.

46  {}

◆ print()

virtual void souffle::ram::analysis::Analysis::print ( std::ostream &  ) const
inlinevirtual

Print the analysis result in HTML format.

Reimplemented in souffle::ram::analysis::IndexAnalysis.

Definition at line 52 of file Analysis.h.

54 :
55  /** @brief name of analysis instance */

◆ run()

virtual void souffle::ram::analysis::Analysis::run ( const TranslationUnit translationUnit)
pure virtual

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const Analysis other 
)
friend

define output stream operator

Definition at line 55 of file Analysis.h.

Field Documentation

◆ identifier

std::string souffle::ram::analysis::Analysis::identifier
protected

name of analysis instance

Definition at line 62 of file Analysis.h.


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