Device_Logging.cpp

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 
00034 #include "Device_Logging.h"
00035 
00036 /**
00037 * @brief Check if logging is enabled for this device
00038 */
00039 int Device_Logging::isLoggingEnabled(void) { return enabled; }
00040 
00041 /**
00042 * @brief Returns the sample rate for the device, rate is in seconds
00043 */
00044 int Device_Logging::getLoggingSampleRate(void) { return sampleRate; }
00045 
00046 /**
00047 * @brief Initialize the sampling rate for the device
00048 * @param sampleRate Rate to log device output in seconds
00049 */
00050 void Device_Logging::initStart(int sampleRate) {
00051   this->sampleRate = sampleRate;
00052   enabled = 1;
00053 }
00054 
00055 /**
00056 * @brief Disables further datalog and streaming sampling for the device
00057 * @param time Time for next sample in seconds, time is relative to a timer
00058 */
00059 void Device_Logging::stop(void) { enabled = 0; }
00060 
00061 /**
00062 * @brief Gets a value that represents when device needs to be sampled again,
00063 * used for datalogging and usb streaming
00064 */
00065 int Device_Logging::getNextSampleTime(void) { return nextSampleTime; }
00066 
00067 /**
00068 * @brief Sets a value that represents when device needs to be sampled again,
00069 * used for datalogging and usb streaming
00070 * @param time Time for next sample in seconds, time is relative to a timer
00071 */
00072 void Device_Logging::setNextSampleTime(int time) { nextSampleTime = time; }