state.cpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_common_libdaq
 * @copyright 2022 ESO - European Southern Observatory
 *
 * @brief Definitions from daq/state.hpp
 */
#include <daq/state.hpp>
 
#include <ostream>
#include <log4cplus/loggingmacros.h>
namespace daq {
 
 
bool IsFinalState(State state) noexcept {
    switch (state) {
        case State::Aborted:
        case State::Completed:
            return true;
        default:
            return false;
    }
}
 
bool IsAbortableState(State state) noexcept {
    // If DAQ is already in final state it cannot be aborted.
    return !IsFinalState(state);
}
 
bool IsActiveDpmState(State state) noexcept {
    switch (state) {
        case State::Scheduled:
        case State::Collecting:
        case State::Merging:
        case State::Releasing:
        case State::AbortingMerging:
            return true;
        default:
            return false;
    }
}
 
bool IsSubsequentState(State state1, State state2) noexcept {
    if (state1 == state2) {
        return false;
    }
    // If state2 is a final state1 it doesn't matter what state1 is, it cannot occur after a final state
    if (IsFinalState(state2)) {
        return false;
    }
 
    // note: We take advantage of that the life-cycle is completely linear, *except* for 
    // aborting + aborted. So those are checked first.
    // As it's always possible to abort: Aborting can occur state2 any state except Aborted.
 
    if ((state2 == State::AbortingAcquiring) || (state2 == State::AbortingMerging)) {
        // Only subsequent state after Aborting* is Aborted
        return state1 == State::Aborted;
    }
 
    // What remains is the linear state1s for the normal life-cycle
    return static_cast<int>(state1) > static_cast<int>(state2);
}
 
std::ostream& operator<<(std::ostream& os, State state) {
    switch (state) {
    case State::NotStarted:
        os << "NotStarted";
        return os;
    case State::Starting:
        os << "Starting";
        return os;
    case State::Acquiring:
        os << "Acquiring";
        return os;
    case State::Stopping:
        os << "Stopping";
        return os;
    case State::Stopped:
        os << "Stopped";
        return os;
 
    case State::NotScheduled:
        os << "NotScheduled";
        return os;
    case State::Scheduled:
        os << "Scheduled";
        return os;
    case State::Collecting:
        os << "Collecting";
        return os;
    case State::Merging:
        os << "Merging";
        return os;
    case State::Releasing:
        os << "Releasing";
        return os;
 
    case State::AbortingAcquiring:
        os << "AbortingAcquiring";
        return os;
    case State::AbortingMerging:
        os << "AbortingMerging";
        return os;
    case State::Aborted:
        os << "Aborted";
        return os;
 
    case State::Completed:
        os << "Completed";
        return os;
    // GCOVR_EXCL_START
    default:
        os << "Unknown";
        return os;
        // GCOVR_EXCL_STOP
    }
}
 
} // namespace daq