Gobelijn API documentation  - generated for commit a0cbea7
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
UA_CoMP::Timekeeper::Timeable< C, D > Class Template Referenceabstract

Records durations associated with a name. More...

#include <Timeable.h>

Collaboration diagram for UA_CoMP::Timekeeper::Timeable< C, D >:
Collaboration graph

Public Types

using Duration = D
 Type for time duration units. More...
 
using Timings = UA_CoMP::Timekeeper::CumulativeRecords< D >
 Records with timing info. More...
 
using Clock = C
 Type for clock. More...
 
using Stopwatch = UA_CoMP::Clock::Stopwatch< C >
 Clock used to obtain timing info. More...
 

Public Member Functions

virtual ~Timeable ()
 Destructor virtual for polymorphic class. More...
 
virtual TimingsType GetTimings () const =0
 Timings in duration units specified above. More...
 

Detailed Description

template<typename C = ClockCLib, typename D = C::duration>
class UA_CoMP::Timekeeper::Timeable< C, D >

Records durations associated with a name.

Template parameter is duration type (default std::chrono::seconds).

Definition at line 33 of file Timeable.h.

Member Typedef Documentation

template<typename C = ClockCLib, typename D = C::duration>
using UA_CoMP::Timekeeper::Timeable< C, D >::Duration = D

Type for time duration units.

Definition at line 37 of file Timeable.h.

template<typename C = ClockCLib, typename D = C::duration>
using UA_CoMP::Timekeeper::Timeable< C, D >::Timings = UA_CoMP::Timekeeper::CumulativeRecords<D>

Records with timing info.

Definition at line 40 of file Timeable.h.

template<typename C = ClockCLib, typename D = C::duration>
using UA_CoMP::Timekeeper::Timeable< C, D >::Clock = C

Type for clock.

Definition at line 43 of file Timeable.h.

template<typename C = ClockCLib, typename D = C::duration>
using UA_CoMP::Timekeeper::Timeable< C, D >::Stopwatch = UA_CoMP::Clock::Stopwatch<C>

Clock used to obtain timing info.

Definition at line 46 of file Timeable.h.

Constructor & Destructor Documentation

template<typename C = ClockCLib, typename D = C::duration>
virtual UA_CoMP::Timekeeper::Timeable< C, D >::~Timeable ( )
inlinevirtual

Destructor virtual for polymorphic class.

Definition at line 50 of file Timeable.h.

Member Function Documentation

template<typename C = ClockCLib, typename D = C::duration>
virtual TimingsType UA_CoMP::Timekeeper::Timeable< C, D >::GetTimings ( ) const
pure virtual

Timings in duration units specified above.


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