Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
ProfileResultFileDOT Class Reference

Write out DOT file for calling hierarchy. More...

#include <internal_result.h>

Inherits ProfileResultInterface.

Public Types

enum  { MAX_FUNCTIONS_PER_FILE = 200 }
 

Public Member Functions

virtual const char * GetName (void) const
 
virtual void WriteResults (void)
 Write out results.
 
virtual void Delete (void)
 Destroys the current result function.
 

Static Public Member Functions

static ProfileResultInterfaceCreate (int argn, const char *const *)
 Creates a class instance.
 

Additional Inherited Members

- Protected Member Functions inherited from ProfileResultInterface
 ProfileResultInterface (void)
 

Detailed Description

Write out DOT file for calling hierarchy.

The frame name and the file name must be specified when creating an instance of this result function. The result function will always pick the thread with the highest function count (which is usually the main thread).

Note
A DOT file is used with the DOT tool from the GraphViz package for generating directed graphs, e.g. by issuing dot -Tgif -ograph.gif profile.dot

Definition at line 60 of file internal_result.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MAX_FUNCTIONS_PER_FILE 

Definition at line 63 of file internal_result.h.

Member Function Documentation

◆ Create()

ProfileResultInterface * ProfileResultFileDOT::Create ( int argn,
const char *const * argv )
static

Creates a class instance.

Parameters
fileNamename of DOT file to generate (defaults to profile.dot)
frameNamename of frame to use (NULL for global)
foldThresholdif the number of functions exceeds the given threshold then all functions belonging to the same source file will be folded into a single entry
Returns
new instance

Definition at line 142 of file profile_result.cpp.

◆ Delete()

void ProfileResultFileDOT::Delete ( void )
virtual

Destroys the current result function.

Use this function instead of just delete'ing the instance.

Implements ProfileResultInterface.

Definition at line 300 of file profile_result.cpp.

◆ GetName()

virtual const char * ProfileResultFileDOT::GetName ( void ) const
inlinevirtual

Definition at line 80 of file internal_result.h.

◆ WriteResults()

void ProfileResultFileDOT::WriteResults ( void )
virtual

Write out results.

This function is called on program exit.

Implements ProfileResultInterface.

Definition at line 166 of file profile_result.cpp.


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