Firmware enhancements for HSP_RPC_GUI 3.0.1

Dependencies:   USBDevice

Fork of HSP_RPC_GUI by Maxim Integrated

Embed: (wiki syntax)

« Back to documentation index

Device_Logging Class Reference

Device_Logging Class Reference

Class that is used to store device logging parameters when logging to flash or streaming usb. More...

#include <Device_Logging.h>

Public Member Functions

int isLoggingEnabled (void)
 Check if logging is enabled for this device.
int getLoggingSampleRate (void)
 Returns the sample rate for the device, rate is in seconds.
void initStart (int sampleRate)
 Initialize the sampling rate for the device.
int getNextSampleTime (void)
 Gets a value that represents when device needs to be sampled again, used for datalogging and usb streaming.
void setNextSampleTime (int time)
 Sets a value that represents when device needs to be sampled again, used for datalogging and usb streaming.
void stop (void)
 Disables further datalog and streaming sampling for the device.

Detailed Description

Class that is used to store device logging parameters when logging to flash or streaming usb.

Definition at line 42 of file Device_Logging.h.


Member Function Documentation

int getLoggingSampleRate ( void   )

Returns the sample rate for the device, rate is in seconds.

Definition at line 44 of file Device_Logging.cpp.

int getNextSampleTime ( void   )

Gets a value that represents when device needs to be sampled again, used for datalogging and usb streaming.

Definition at line 65 of file Device_Logging.cpp.

void initStart ( int  sampleRate )

Initialize the sampling rate for the device.

Parameters:
sampleRateRate to log device output in seconds

Definition at line 50 of file Device_Logging.cpp.

int isLoggingEnabled ( void   )

Check if logging is enabled for this device.

Definition at line 39 of file Device_Logging.cpp.

void setNextSampleTime ( int  time )

Sets a value that represents when device needs to be sampled again, used for datalogging and usb streaming.

Parameters:
timeTime for next sample in seconds, time is relative to a timer

Definition at line 72 of file Device_Logging.cpp.

void stop ( void   )

Disables further datalog and streaming sampling for the device.

Parameters:
timeTime for next sample in seconds, time is relative to a timer

Definition at line 59 of file Device_Logging.cpp.