LASP 1.0
Library for Acoustic Signal Processing
Loading...
Searching...
No Matches
Daq::StreamStatus Class Reference

Information regarding a stream. More...

#include <lasp_daq.h>

Public Types

enum class  StreamError {
  noError , inputXRun , outputXRun , driverError ,
  systemError , threadError , logicError
}
 

Public Member Functions

bool error () const
 Check if stream has error.
 
std::string errorMsg () const
 
bool runningOK () const
 Returns true if everything is OK with a certain stream and the stream is running.
 

Public Attributes

bool isRunning = false
 
StreamError errorType {StreamError::noError}
 

Static Public Attributes

static const std::map< StreamError, std::string > errorMessages
 Map between error types and messages.
 

Detailed Description

Information regarding a stream.

Definition at line 39 of file lasp_daq.h.

Member Enumeration Documentation

◆ StreamError

enum class Daq::StreamStatus::StreamError
strong
Enumerator
noError 
inputXRun 
outputXRun 
driverError 
systemError 
threadError 
logicError 

Definition at line 41 of file lasp_daq.h.

Member Function Documentation

◆ error()

bool Daq::StreamStatus::error ( ) const
inline

Check if stream has error.

Returns
true if there is an error.

Definition at line 70 of file lasp_daq.h.

◆ errorMsg()

std::string Daq::StreamStatus::errorMsg ( ) const
inline

Definition at line 74 of file lasp_daq.h.

◆ runningOK()

bool Daq::StreamStatus::runningOK ( ) const
inline

Returns true if everything is OK with a certain stream and the stream is running.

Returns
as described above.

Definition at line 82 of file lasp_daq.h.

Member Data Documentation

◆ errorMessages

const std::map<StreamError, std::string> Daq::StreamStatus::errorMessages
inlinestatic
Initial value:

Map between error types and messages.

Definition at line 54 of file lasp_daq.h.

◆ errorType

StreamError Daq::StreamStatus::errorType {StreamError::noError}

Definition at line 72 of file lasp_daq.h.

◆ isRunning

bool Daq::StreamStatus::isRunning = false

Definition at line 64 of file lasp_daq.h.


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