PhasedObject.hpp

Go to the documentation of this file.

// <PhasedObject> -*- C++ -*-
 
#pragma once
 
#include "sparta/utils/Utils.hpp"
#include "sparta/utils/SpartaException.hpp"
#include "sparta/utils/SpartaAssert.hpp"
#include "sparta/utils/Printing.hpp"
#include "sparta/utils/StringManager.hpp"
 
namespace sparta
{
 
    class PhasedObject
    {
    public:
 
 
        enum TreePhase {
            TREE_BUILDING    = 0,
 
            TREE_CONFIGURING = 1,
 
            TREE_FINALIZING  = 2,
 
            TREE_FINALIZED   = 3,
 
            TREE_TEARDOWN    = 4
        };
 
 
 
 
        PhasedObject() :
            phase_(TREE_BUILDING)
        { }
 
        PhasedObject(PhasedObject&&) = default;
 
        virtual ~PhasedObject()
        { }
 
 
 
        virtual const std::string& getName() const = 0;
 
        virtual std::string getLocation() const = 0;
 
 
        TreePhase getPhase() const {
            return phase_;
        }
 
        virtual bool isBuilding() const {
            return phase_ == TREE_BUILDING;
        }
 
        virtual bool isBuilt() const {
            return phase_ > TREE_BUILDING;
        }
 
        virtual bool isConfigured() const {
            return phase_ > TREE_CONFIGURING;
        }
 
        virtual bool isConfiguring() const {
            return phase_ == TREE_CONFIGURING;
        }
 
        virtual bool isFinalizing() const {
            return phase_ == TREE_FINALIZING;
        }
 
        virtual bool isFinalized() const {
            return phase_ == TREE_FINALIZED;
        }
 
        virtual bool isTearingDown() const {
            return phase_ == TREE_TEARDOWN;
        }
 
    protected:
 
        void setPhase_(TreePhase phase) {
            phase_ = phase;
        }
 
    private:
 
        TreePhase phase_;
    };
 
} // namespace sparta