Running Manager  1.7
API for Running Manager (https://github.com/HWiman-ICONIC/running-manager)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Training Struct Reference

A training/activity. More...

#include <Training.h>

Public Member Functions

wxString ToString (bool includeDate, PTUnit const &unit)
 Return human readable string. More...
 
void GetTime (wxTimeSpan &minTime, wxTimeSpan &maxTime, wxTimeSpan &avgSpan)
 Get min, max and average time for this activity. More...
 
void GetDistance (double &minDist, double &maxDist, double &avgDist, PTUnit const &unit)
 Get min, max and average distance for this activity. More...
 

Static Public Member Functions

static bool compareDate (const Training &a, const Training &b)
 Helper for sorting activities by date. More...
 

Public Attributes

PTTrainingType type
 
int intensity
 
wxDateTime date
 

Detailed Description

A training/activity.

Member Function Documentation

◆ compareDate()

static bool Training::compareDate ( const Training a,
const Training b 
)
static

Helper for sorting activities by date.

Parameters
aFirst
bSecond
Returns
First is before second

◆ GetDistance()

void Training::GetDistance ( double &  minDist,
double &  maxDist,
double &  avgDist,
PTUnit const &  unit 
)

Get min, max and average distance for this activity.

Parameters
minDistMin
maxDistMax
avgDistAverage
unitkm|miles

◆ GetTime()

void Training::GetTime ( wxTimeSpan &  minTime,
wxTimeSpan &  maxTime,
wxTimeSpan &  avgSpan 
)

Get min, max and average time for this activity.

Parameters
minTimeMin
maxTimeMax
avgSpanAverage

◆ ToString()

wxString Training::ToString ( bool  includeDate,
PTUnit const &  unit 
)

Return human readable string.

Parameters
includeDateInclude date in returned string
unitUnit (km|miles)
Returns
human readable string

Member Data Documentation

◆ date

wxDateTime Training::date

◆ intensity

int Training::intensity

◆ type

PTTrainingType Training::type

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