Fawkes API Fawkes Development Version
fawkes::SyncPointCall Class Reference

A call (wait() or emit()) to a SyncPoint. More...

#include <>>

Public Member Functions

 SyncPointCall (const std::string &caller, Time call_time=Time(), Time wait_time=Time(0.f))
 Constructor. More...
 
Time get_call_time () const
 Get the time when the call was made. More...
 
Time get_wait_time () const
 Get the wait time. More...
 
std::string get_caller () const
 Get the name of the component which made the call. More...
 

Detailed Description

A call (wait() or emit()) to a SyncPoint.

Author
Till Hofmann
See also
SyncPoint

Definition at line 31 of file syncpoint_call.h.

Constructor & Destructor Documentation

◆ SyncPointCall()

fawkes::SyncPointCall::SyncPointCall ( const std::string &  caller,
Time  call_time = Time(),
Time  wait_time = Time(0.f) 
)

Constructor.

Parameters
call_timeTime at which the SyncPoint was called
callerThe calling component
wait_timeThe time the caller had to wait for the SyncPoint (wait calls)

Definition at line 37 of file syncpoint_call.cpp.

Member Function Documentation

◆ get_call_time()

Time fawkes::SyncPointCall::get_call_time ( ) const

Get the time when the call was made.

Returns
the call time

Definition at line 46 of file syncpoint_call.cpp.

Referenced by fawkes::SyncPointCallStats::update_calls().

◆ get_caller()

std::string fawkes::SyncPointCall::get_caller ( ) const

Get the name of the component which made the call.

Returns
the component name

Definition at line 64 of file syncpoint_call.cpp.

◆ get_wait_time()

Time fawkes::SyncPointCall::get_wait_time ( ) const

Get the wait time.

Returns
the wait time

Definition at line 55 of file syncpoint_call.cpp.

Referenced by fawkes::SyncPointCallStats::update_calls().


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