Fawkes API
Fawkes Development Version
syncpoint_call.cpp
1
/***************************************************************************
2
* syncpoint_call.cpp - Utility class to represent a call to a SyncPoint
3
*
4
* Created: Fri Aug 15 18:12:42 2014
5
* Copyright 2014 Till Hofmann
6
*
7
****************************************************************************/
8
9
/* This program is free software; you can redistribute it and/or modify
10
* it under the terms of the GNU General Public License as published by
11
* the Free Software Foundation; either version 2 of the License, or
12
* (at your option) any later version.
13
*
14
* This program is distributed in the hope that it will be useful,
15
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
* GNU Library General Public License for more details.
18
*
19
* Read the full text in the LICENSE.GPL file in the doc directory.
20
*/
21
22
#include <syncpoint/syncpoint_call.h>
23
24
namespace
fawkes
{
25
26
/** @class SyncPointCall <syncpoint/syncpoint.h>
27
* A call (wait() or emit()) to a SyncPoint.
28
* @author Till Hofmann
29
* @see SyncPoint
30
*/
31
32
/** Constructor.
33
* @param call_time Time at which the SyncPoint was called
34
* @param caller The calling component
35
* @param wait_time The time the caller had to wait for the SyncPoint (wait calls)
36
*/
37
SyncPointCall::SyncPointCall
(
const
std::string &caller, Time call_time, Time wait_time)
38
: caller_(caller), call_time_(call_time), wait_time_(wait_time)
39
{
40
}
41
42
/** Get the time when the call was made
43
* @return the call time
44
*/
45
Time
46
SyncPointCall::get_call_time
()
const
47
{
48
return
call_time_;
49
}
50
51
/** Get the wait time
52
* @return the wait time
53
*/
54
Time
55
SyncPointCall::get_wait_time
()
const
56
{
57
return
wait_time_;
58
}
59
60
/** Get the name of the component which made the call
61
* @return the component name
62
*/
63
std::string
64
SyncPointCall::get_caller
()
const
65
{
66
return
caller_;
67
}
68
69
}
// namespace fawkes
fawkes::SyncPointCall::get_caller
std::string get_caller() const
Get the name of the component which made the call.
Definition:
syncpoint_call.cpp:68
fawkes::SyncPointCall::get_call_time
Time get_call_time() const
Get the time when the call was made.
Definition:
syncpoint_call.cpp:50
fawkes
fawkes::Time
Definition:
time.h:96
fawkes::SyncPointCall::SyncPointCall
SyncPointCall(const std::string &caller, Time call_time=Time(), Time wait_time=Time(0.f))
Constructor.
Definition:
syncpoint_call.cpp:41
fawkes::SyncPointCall::get_wait_time
Time get_wait_time() const
Get the wait time.
Definition:
syncpoint_call.cpp:59
src
libs
syncpoint
syncpoint_call.cpp
Generated by
1.8.16