finder.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_LIB_FINDER_FINDER_H__
#define __ANTARES_LIB_FINDER_FINDER_H__
 
#include <mutex>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
#include <yuni/io/directory/iterator.h>
 
#include "antares/study/study.h"
 
#include "../version.h"
 
namespace Antares::Data
{
class StudyFinder
{
public:
    enum
    {
        defaultTimeout = 10000, // 10s
    };
 
    using FolderVector = std::vector<Yuni::String::Ptr>;
 
public:
 
 
    StudyFinder();
    StudyFinder(const StudyFinder&);
    virtual ~StudyFinder();
 
    void lookup(const Yuni::String& folder);
 
    void lookup(const Yuni::String::Vector& folders);
    void lookup(const Yuni::String::List& folders);
 
    void stop(uint timeout = defaultTimeout);
 
    void wait();
 
    void wait(uint timeout);
 
public: // Events
    virtual void onStudyFound(const Yuni::String& folder, const StudyVersion& version) = 0;
 
    virtual void onLookupFinished()
    {
    }
 
    virtual void onLookupAborted()
    {
    }
 
protected:
    std::mutex mutex;
 
private:
    Yuni::IO::Directory::IIterator<true>* pLycos;
 
}; // class StudyFinder
 
} // namespace Antares::Data
 
#endif // __ANTARES_LIB_FINDER_FINDER_H__