dunedaq::snbmodules::status_type Struct Reference

#include <status_enum.hpp>

Public Types
enum	e_status {   PREPARING , ERROR , SUCCESS_UPLOAD , SUCCESS_DOWNLOAD ,   FINISHED , CANCELLED , PAUSED , WAITING ,   CHECKING , HASHING , UPLOADING , DOWNLOADING }
	Different type of session status Need to be sorted by priority (highest last). More...

Static Public Member Functions
static std::string	status_to_string (e_status e)
static std::optional< e_status >	string_to_status (std::string s)

Detailed Description

Definition at line 17 of file status_enum.hpp.

Member Enumeration Documentation

e_status

enum dunedaq::snbmodules::status_type::e_status

Different type of session status Need to be sorted by priority (highest last).

Enumerator
PREPARING	waiting for the transfer to start, can be waiting to receive expected files metadata
ERROR
SUCCESS_UPLOAD
SUCCESS_DOWNLOAD
FINISHED
CANCELLED
PAUSED
WAITING
CHECKING
HASHING
UPLOADING
DOWNLOADING

Definition at line 21 of file status_enum.hpp.

  {
    PREPARING, // when the file is not yet available to execute transfer and need more time (ex: torrent file is being
               // generated)
    ERROR,
 
    SUCCESS_UPLOAD,
    SUCCESS_DOWNLOAD,
    FINISHED,
    CANCELLED,
 
    PAUSED,
    WAITING,
 
    // TODO Aug-14-2022 Leo Joly leo.vincent.andre.joly@cern.ch : should we add more status and specify value ?
 
    CHECKING,
    HASHING,
    UPLOADING,
    DOWNLOADING,
  };

Member Function Documentation

status_to_string()

std::string dunedaq::snbmodules::status_type::status_to_string ( e_status e )

inlinestatic

Definition at line 45 of file status_enum.hpp.

  {
    const std::map<e_status, std::string> MyEnumStrings{ { PREPARING, "PREPARING" },
                                                         { ERROR, "ERROR" },
                                                         { SUCCESS_UPLOAD, "SUCCESS_UPLOAD" },
                                                         { SUCCESS_DOWNLOAD, "SUCCESS_DOWNLOAD" },
                                                         { FINISHED, "FINISHED" },
                                                         { CANCELLED, "CANCELLED" },
                                                         { PAUSED, "PAUSED" },
                                                         { WAITING, "WAITING" },
                                                         { CHECKING, "CHECKING" },
                                                         { HASHING, "HASHING" },
                                                         { UPLOADING, "UPLOADING" },
                                                         { DOWNLOADING, "DOWNLOADING" } };
    auto it = MyEnumStrings.find(e);
    return it == MyEnumStrings.end() ? "Not supported" : it->second;
  }

string_to_status()

std::optional< e_status > dunedaq::snbmodules::status_type::string_to_status ( std::string s )

inlinestatic

Definition at line 63 of file status_enum.hpp.

  {
    const std::map<std::string, e_status> MyStringsEnum{ { "PREPARING", PREPARING },
                                                         { "ERROR", ERROR },
                                                         { "SUCCESS_UPLOAD", SUCCESS_UPLOAD },
                                                         { "SUCCESS_DOWNLOAD", SUCCESS_DOWNLOAD },
                                                         { "FINISHED", FINISHED },
                                                         { "CANCELLED", CANCELLED },
                                                         { "PAUSED", PAUSED },
                                                         { "WAITING", WAITING },
                                                         { "CHECKING", CHECKING },
                                                         { "HASHING", HASHING },
                                                         { "UPLOADING", UPLOADING },
                                                         { "DOWNLOADING", DOWNLOADING } };
    auto it = MyStringsEnum.find(s);
    if (it == MyStringsEnum.end()) {
      return std::nullopt;
    }
    return it->second;
  }

---

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

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/common/status_enum.hpp