SchedulingPhases.hpp

Go to the documentation of this file.

// <SchedulingPhases.hpp> -*- C++ -*-
 
 
#pragma once
 
#include <cinttypes>
#include <iostream>
 
namespace sparta
{
 
    enum class SchedulingPhase
    {
#ifndef DO_NOT_DOCUMENT
        Trigger,        
#endif
        Update,         
        PortUpdate,     
        Flush,          
        Collection,     
        Tick,           
        PostTick,       
#ifndef DO_NOT_DOCUMENT
        __last_scheduling_phase,
        Invalid = __last_scheduling_phase
#endif
    };
 
    const uint32_t NUM_SCHEDULING_PHASES =
        static_cast<uint32_t>(SchedulingPhase::__last_scheduling_phase);
 
    inline std::ostream & operator<<(std::ostream & os, const SchedulingPhase & phase)
    {
        switch (phase) {
        case SchedulingPhase::Trigger:
            os << "Trigger";
            break;
        case SchedulingPhase::Update:
            os << "Update";
            break;
        case SchedulingPhase::PortUpdate:
            os << "PortUpdate";
            break;
        case SchedulingPhase::Flush:
            os << "Flush";
            break;
        case SchedulingPhase::Collection:
            os << "Collection";
            break;
        case SchedulingPhase::Tick:
            os << "Tick";
            break;
        case SchedulingPhase::PostTick:
            os << "PostTick";
            break;
        case SchedulingPhase::__last_scheduling_phase:
            os << "<UNKNOWN PHASE>";
            break;
            // NO DEFAULT!  Allows for compiler errors if the enum
            // class is updated.
        }
        return os;
    }
 
}