If.h

Go to the documentation of this file.

// Copyright 2024-2025 Julien Lamy, ICube, Université de Strasbourg-CNRS.
// Part of msl, distributed under the terms of the MIT license.
 
#ifndef _29882abf_80e7_4434_8f2c_b5109dd75ef7
#define _29882abf_80e7_4434_8f2c_b5109dd75ef7
 
#include <functional>
#include <string>
 
#include <boost/variant/variant.hpp>
 
#include <MrMeasSrv/MeasUtils/NLSStatus.h>
#include <MrMeasSrv/SeqIF/libRT/sSLICE_POS.h>
 
#include <MrProtSrv/Domain/CoreNative/SeqLim.h>
#include <MrProtSrv/Domain/MrProtData/MrProt/MrProt.h>
#include <MrProtSrv/Domain/MrProtData/MrProt/SeqIF/SeqExpo.h>
#include <MrProtSrv/Domain/MrProtData/MrProt/SeqIF/SeqExpoRFBlockInfo.h>
 
#include "msl/Dictionary.h"
#include "msl/graph/Node.h"
 
namespace msl
{
namespace graph
{

class If: public Node
{
public:
    DECLARE_POINTERS(If);
    
    // NOTE: most of the Siemens API is not const-correct
    using Function = boost::variant<
        std::function<bool()>,
        std::function<bool(MrProt &)>,
        std::function<bool(MrProt &, SeqLim &, SeqExpo &)>>;
    
    static Pointer New(
        std::string const & key, Dictionary::Pointer registry={});
    
    template<typename T>
    static Pointer New(
        std::string const & key, T const & child,
        Dictionary::Pointer registry={})
    {
        return Pointer(new If(key, child, registry));
    }
    
    static Pointer New(
        std::string const & key, Siblings const & siblings,
        Dictionary::Pointer registry={});
    
    virtual ~If() = default;
    
    NLSStatus prepare(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    NLSStatus run(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    uint64_t duration() const override;
    
    MrProtocolData::SeqExpoRFInfo rfInfo() const override;
    
private:
    std::string _key;
    
    // NOTE: SeqLim is an abstract class. Since the concrete object may change
    // between calls to ::prepare or ::run, it can only be stored in a pointer.
    mutable bool _hasCache;
    mutable MrProt * _protocol;
    mutable SeqLim * _limits;
    mutable SeqExpo * _exports;
    
    If(std::string const & key, Dictionary::Pointer registry={});
    
    template<typename T>
    If(
        std::string const & key, T const & child,
        Dictionary::Pointer registry={})
    : Node(child, registry), _key(key)
    {
        // Nothing else
    }
    
    If(
        std::string const & key, Siblings const & siblings,
        Dictionary::Pointer registry={});
    
    If(If const &) = default;
    If(If &&) = default;
    If & operator=(If const &) = default;
    If & operator=(If &&) = default;
    
    bool _condition() const;
    bool _condition(MrProt & protocol, SeqLim & limits, SeqExpo & exports) const;
};
}
}
 
#endif // _29882abf_80e7_4434_8f2c_b5109dd75ef7