GEGELATI
Public Member Functions | Protected Attributes | List of all members
TPG::TPGEdgeInstrumented Class Reference

Instrumented TPGEdge class to keep track of a TPG execution statistics. More...

#include <tpgEdgeInstrumented.h>

Inheritance diagram for TPG::TPGEdgeInstrumented:
TPG::TPGEdge

Public Member Functions

 TPGEdgeInstrumented (const TPGVertex *src, const TPGVertex *dest, const std::shared_ptr< Program::Program > prog)
 Default constructor.
 
uint64_t getNbVisits () const
 Get the number of time a TPGEdge was visited. More...
 
void incrementNbVisits () const
 Add one to the number of visits for this TPGEdge.
 
uint64_t getNbTraversal () const
 Get the number of time a TPGEdge was traversed. More...
 
void incrementNbTraversal () const
 Add one to the number of traversal for this TPGEdge.
 
void reset () const
 Reset the instrumentation attributes.
 
- Public Member Functions inherited from TPG::TPGEdge
virtual ~TPGEdge ()=default
 Default virtual destructor (for polymorphism)
 
 TPGEdge (const TPGVertex *src, const TPGVertex *dest, const std::shared_ptr< Program::Program > prog)
 Main constructor of the TPGEdge class. More...
 
Program::ProgramgetProgram () const
 Get a const reference to the Program of the TPGEdge. More...
 
void setProgram (const std::shared_ptr< Program::Program > prog) const
 Set a new Program for the TPGEdge. More...
 
std::shared_ptr< Program::ProgramgetProgramSharedPointer ()
 Get the shared_pointer to the Program. More...
 
const TPGVertexgetSource () const
 Get the source TPGVertex of the TPGEdge. More...
 
void setSource (TPGVertex *newSource)
 Set a new source TPGVertex to the TPGEdge. More...
 
const TPGVertexgetDestination () const
 Get the destination TPGVertex of the TPGEdge. More...
 
void setDestination (TPGVertex *newDestination)
 Set a new destination TPGVertex to the TPGEdge. More...
 

Protected Attributes

std::atomic_uint64_t nbVisits
 
std::atomic_uint64_t nbTraversal
 
- Protected Attributes inherited from TPG::TPGEdge
const TPGVertexsource
 Pointer to the source TPGVertex of this TPGEdge.
 
const TPGVertexdestination
 Pointer to the destination TPGVertex of this TPGEdge.
 
std::shared_ptr< Program::Programprogram
 

Additional Inherited Members

- Protected Member Functions inherited from TPG::TPGEdge
 TPGEdge ()=delete
 Delete the default constructor.
 

Detailed Description

Instrumented TPGEdge class to keep track of a TPG execution statistics.

Member Function Documentation

◆ getNbTraversal()

uint64_t TPG::TPGEdgeInstrumented::getNbTraversal ( ) const

Get the number of time a TPGEdge was traversed.

That is the number of time its program produced the winning bid.

◆ getNbVisits()

uint64_t TPG::TPGEdgeInstrumented::getNbVisits ( ) const

Get the number of time a TPGEdge was visited.

That is the number of time it caused an execution of its program.

Member Data Documentation

◆ nbTraversal

std::atomic_uint64_t TPG::TPGEdgeInstrumented::nbTraversal
mutableprotected

Number of a time a TPGEdge has been traversed That is the number of time its program produced the winning bid. Attribute is mutable because all TPGEdge are seen as const outside from their TPGGraph.

◆ nbVisits

std::atomic_uint64_t TPG::TPGEdgeInstrumented::nbVisits
mutableprotected

Number of a time a TPGEdge has been visited That is the number of time it caused an execution of its program. Attribute is mutable because all TPGEdge are seen as const outside from their TPGGraph.


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