3rd Repo, trying to figure this out.
Fork of SOFT253_Template_Weather_OS_54 by
Diff: CircularArray/CircularArray.cpp
- Revision:
- 85:422d0a1b95cf
- Parent:
- 83:0d3572a8a851
diff -r 16a3eabfb61f -r 422d0a1b95cf CircularArray/CircularArray.cpp --- a/CircularArray/CircularArray.cpp Thu May 11 19:27:45 2017 +0000 +++ b/CircularArray/CircularArray.cpp Sat May 13 17:35:58 2017 +0000 @@ -2,6 +2,21 @@ #include <stdio.h> #include <ctype.h> +/** + @file : CircularArray.cpp + @authors : Radu Marcu, Jacob Williams, Niall Francis, Arron Burch + + @section DESCRIPTION + + This is the circular array class responsible for managing data stored in the circular array. + It handles all functions related to the stored measures, including pushing measures to the next available + space, pulling the first measure, as well as reading and deleting measures. As this is a circular buffer, + if there is a new measure added and not enough room for it, the oldest measures will be removed in order + to make space. + This class was written to be fairly robust; if it is asked to delete or read more measures than it + contains, the class can adapt and delete or read the highest possible value. + +*/ CircularArray::CircularArray(int limit, MessageLogger *newLogger) {