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

A training week. More...

#include <Week.h>

Public Member Functions

 Week ()
 Constructor. More...
 
wxString ToString ()
 Return human readable string. More...
 
wxString GetPhaseString () const
 Get which phase this week is in. More...
 
bool SetPhase (wxString const &sPhase)
 Set phase for this week. More...
 
void GetTime (wxTimeSpan &minTime, wxTimeSpan &maxTime, wxTimeSpan &avgSpan)
 Get total min, max and average time fro this week. More...
 
void GetDistance (double &minDist, double &maxDist, double &avgDist, PTUnit const &unit)
 Get total min, max and average distance for this week. More...
 
void Sort ()
 Sort week based on training dates. More...
 

Public Attributes

int number
 
PTPhase cPhase
 
std::list< Trainingtraining
 

Detailed Description

A training week.

Contains a number of Traning instances or activities

Constructor & Destructor Documentation

◆ Week()

Week::Week ( )

Constructor.

Member Function Documentation

◆ GetDistance()

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

Get total min, max and average distance for this week.

Parameters
minDistMin
maxDistMax
avgDistAverage
unitkm|miles

◆ GetPhaseString()

wxString Week::GetPhaseString ( ) const

Get which phase this week is in.

Returns

◆ GetTime()

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

Get total min, max and average time fro this week.

Parameters
minTimeMin
maxTimeMax
avgSpanAverage

◆ SetPhase()

bool Week::SetPhase ( wxString const &  sPhase)

Set phase for this week.

Parameters
sPhase
Returns

◆ Sort()

void Week::Sort ( )

Sort week based on training dates.

◆ ToString()

wxString Week::ToString ( )

Return human readable string.

Returns
human readable string

Member Data Documentation

◆ cPhase

PTPhase Week::cPhase

◆ number

int Week::number

◆ training

std::list<Training> Week::training

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