Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Language Terms

TermDefinition
Workout Definition (WD)A static entity that is a template for a workout (e.g. a running, gym training, etc).
Workout Activity (WA)An entity representing a performed workout - an actual instance of a workout that the user performed on a specific date.
Exercise Definition (ED)A static entity that represents a single template exercise (e.g. push-ups).
Exercise Activity (EA)An entity representing an exercise that was performed as part of a Workout Activity.

Anchor
WorkoutDefinition
WorkoutDefinition
Workout Definition (WD)

An entity that defines a 'workout template' that consists of one or more exercises that are completed in order by the user. A new Workout Activity (WA) can only be created based on a WD.

...

NameNotes
TypeThe type of workout (Interval Training, Running, Cycling, Mixed, etc). This may not be a property in the data model. Maybe subclassing would be more appropriate.
TitleThe title of the workout.
DescriptionThe user-facing description of the workout.
ExercisesThe list of Exercise Definitions that are included in the workout, plus their duration.
Break DurationThe duration of the break countdown between exercises.

Anchor
WorkoutActivity
WorkoutActivity
Workout Activity (WA)

An entity that represents a single workout performed by the user at a specific point in time. It captures all data about that activity and can be used to calculate Post-exercise Calorie Burn (PCB) in the 24 hour period after completion.

...

NameNotes
Workout Definition ReferenceA reference to the WD that this activity was created from.
CreatedThe date/time the WA was created.
CompletedThe date/time the WA was completed.
ExercisesThe list of Exercise Activities that were performed in the workout, including their duration.
Active Calories BurnedThe total calories burned during the workout.
Completion Heart RateThe user's HR on completion of the activity.
Perceived ExertionThe user's perceived exertion level on completion of the activity.

Anchor
ExerciseDefinition
ExerciseDefinition
Exercise Definition (ED)

An entity that defines an 'exercise template'. It captures all info relating to a specific exercise. An ED can be included in multiple Workout Definitions and then completed as part of a Workout Activity.

There are multiple exercise behaviours that relate specifically to the different types of workout described in the Workout Definitions section. Specific workout types will consist of exercises that are specific to that type and have specific presentation and storage needs. For example, a 5k run will require specific UI, UX and data that is not appropriate for a timed interval of push-ups. The only behaviour needed for v1.0 is Interval Training Step, which specifies a set duration that is presented to the user via a countdown timer.

Properties

NameNotes
BehaviourThe behaviour type of the ED - e.g. Interval Training Step.
TitleThe title of the exercise.
DescriptionThe user-facing description of the exercise.
VideoAn optional video that is shown during the Exercise Activity (and available via the Exercise Library).
Calorie Burn Per SecondThe baseline number of calories that this exercise burns per second.

Anchor
ExerciseActivity
ExerciseActivity
Exercise Activity (EA)

An entity that represents a single exercise performed by the user as part of a Workout Activity. It captures data about what that exercise was and how many calories the user burned.

Properties

NameNotes
Exercise Definition ReferenceA reference to the ED that this activity was created from.
Workout Activity ReferenceA reference to the WA that this activity is part of.
CreatedThe date/time the EA was created.
DurationThe length of time that this exercise activity was performed for.