PlasCom2  1.0
XPACC Multi-physics simluation application
Public Member Functions | Protected Attributes | Friends | List of all members
Event Class Reference

Marks construct entry/exit. More...

Detailed Description

Marks construct entry/exit.

Events mark the beginning, end, and duration of instances of user defined code constructs.

Definition at line 152 of file Profiler.H.

#include <Profiler.H>

Public Member Functions

 Event ()
 
 Event (unsigned int i)
 
 Event (unsigned int i, double ts)
 
 Event (unsigned int i, double e, double it)
 
 Event (const Event &e)
 
Event & operator= (const Event &e)
 
double & exclusive ()
 
double exclusive () const
 
double & inclusive ()
 
double inclusive () const
 
void exclusive (double e)
 
void inclusive (double i)
 
double & timestamp ()
 
double timestamp () const
 
void timestamp (double t)
 
unsigned int & id ()
 
unsigned int id () const
 
void id (unsigned int i)
 
bool operator< (const Event &e) const
 

Protected Attributes

unsigned int _id
 unique identifyer More...
 
double _exclusive
 self time More...
 
double _inclusive
 tree time More...
 
double _timestamp
 raw timestamp More...
 

Friends

std::ostream & operator<< (std::ostream &, const Event &)
 EVENT's stream operator. More...
 
std::istream & operator>> (std::istream &, Event &)
 EVENT's stream operator. More...
 

Constructor & Destructor Documentation

◆ Event() [1/5]

Event ( )
inline

Definition at line 174 of file Profiler.H.

◆ Event() [2/5]

Event ( unsigned int  i)
inline

Definition at line 181 of file Profiler.H.

◆ Event() [3/5]

Event ( unsigned int  i,
double  ts 
)
inline

Definition at line 188 of file Profiler.H.

◆ Event() [4/5]

Event ( unsigned int  i,
double  e,
double  it 
)
inline

Definition at line 195 of file Profiler.H.

◆ Event() [5/5]

Event ( const Event &  e)
inline

Definition at line 202 of file Profiler.H.

Member Function Documentation

◆ exclusive() [1/3]

double& exclusive ( )
inline

Definition at line 242 of file Profiler.H.

Referenced by ProfilerObj::FunctionEntry().

Here is the caller graph for this function:

◆ exclusive() [2/3]

double exclusive ( ) const
inline

Definition at line 246 of file Profiler.H.

◆ exclusive() [3/3]

void exclusive ( double  e)
inline

Definition at line 258 of file Profiler.H.

◆ id() [1/3]

unsigned int& id ( )
inline

Definition at line 278 of file Profiler.H.

◆ id() [2/3]

unsigned int id ( ) const
inline

Definition at line 282 of file Profiler.H.

◆ id() [3/3]

void id ( unsigned int  i)
inline

Definition at line 286 of file Profiler.H.

◆ inclusive() [1/3]

double& inclusive ( )
inline

Definition at line 250 of file Profiler.H.

◆ inclusive() [2/3]

double inclusive ( ) const
inline

Definition at line 254 of file Profiler.H.

◆ inclusive() [3/3]

void inclusive ( double  i)
inline

Definition at line 262 of file Profiler.H.

◆ operator<()

bool operator< ( const Event &  e) const
inline

Definition at line 290 of file Profiler.H.

References Event::_timestamp, ix::profiler::operator<<(), and ix::profiler::operator>>().

Here is the call graph for this function:

◆ operator=()

Event& operator= ( const Event &  e)
inline

Definition at line 223 of file Profiler.H.

References Event::_exclusive, Event::_id, Event::_inclusive, and Event::_timestamp.

◆ timestamp() [1/3]

double& timestamp ( )
inline

Definition at line 266 of file Profiler.H.

Referenced by ProfilerObj::FunctionEntry().

Here is the caller graph for this function:

◆ timestamp() [2/3]

double timestamp ( ) const
inline

Definition at line 270 of file Profiler.H.

◆ timestamp() [3/3]

void timestamp ( double  t)
inline

Definition at line 274 of file Profiler.H.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  ost,
const Event &  e 
)
friend

EVENT's stream operator.

Output function for Event.

Definition at line 131 of file Profiler.C.

◆ operator>>

std::istream& operator>> ( std::istream &  ist,
Event &  e 
)
friend

EVENT's stream operator.

Input function for Event.

Definition at line 140 of file Profiler.C.

Member Data Documentation

◆ _exclusive

double _exclusive
protected

self time

Definition at line 159 of file Profiler.H.

Referenced by ix::profiler::operator<<(), Event::operator=(), and ix::profiler::operator>>().

◆ _id

unsigned int _id
protected

unique identifyer

Definition at line 157 of file Profiler.H.

Referenced by ix::profiler::operator<<(), Event::operator=(), and ix::profiler::operator>>().

◆ _inclusive

double _inclusive
protected

tree time

Definition at line 161 of file Profiler.H.

Referenced by ix::profiler::operator<<(), Event::operator=(), and ix::profiler::operator>>().

◆ _timestamp

double _timestamp
protected

raw timestamp

Definition at line 163 of file Profiler.H.

Referenced by Event::operator<(), ix::profiler::operator<<(), Event::operator=(), and ix::profiler::operator>>().

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