Antares Simulator
Power System Simulator
antares-study.h
1 /*
2 ** Copyright 2007-2025, RTE (https://www.rte-france.com)
3 ** See AUTHORS.txt
4 ** SPDX-License-Identifier: MPL-2.0
5 ** This file is part of Antares-Simulator,
6 ** Adequacy and Performance assessment for interconnected energy networks.
7 **
8 ** Antares_Simulator is free software: you can redistribute it and/or modify
9 ** it under the terms of the Mozilla Public Licence 2.0 as published by
10 ** the Mozilla Foundation, either version 2 of the License, or
11 ** (at your option) any later version.
12 **
13 ** Antares_Simulator is distributed in the hope that it will be useful,
14 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ** Mozilla Public Licence 2.0 for more details.
17 **
18 ** You should have received a copy of the Mozilla Public Licence 2.0
19 ** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20 */
21 #ifndef __ANTARES_STUDY_H__
22 #define __ANTARES_STUDY_H__
23 
24 #include <fswalker/fswalker.h>
25 #include <mutex>
26 
28 {
29 public:
30  AntaresStudy(int64_t dateLimit);
31 
32  virtual ~AntaresStudy()
33  {
34  }
35 
36  virtual const char* caption() const;
37 
38  virtual FSWalker::OnDirectoryEvent directoryEvent();
39 
40  virtual int priority() const
41  {
42  return 9999;
43  } // must be first
44 
45  virtual void* userdataCreate(FSWalker::DispatchJobEvent& queue);
46 
47  virtual void userdataDestroy(void* userdata);
48 
49 public:
50  uint64_t bytesDeleted;
51  uint64_t filesDeleted;
52  uint64_t foldersDeleted;
53 
54 private:
55  std::mutex pMutex;
56  int64_t pDateLimit;
57 
58 }; // class AntaresStudy
59 
60 #endif // __ANTARES_STUDY_H__
Definition: antares-study.h:28
virtual void * userdataCreate(FSWalker::DispatchJobEvent &queue)
Get the user data.
Definition: antares-study.cpp:392
virtual int priority() const
Recommended priority for the extension.
Definition: antares-study.h:40
virtual FSWalker::OnDirectoryEvent directoryEvent()
Provide a reentrant event for handling directories.
Definition: antares-study.cpp:387
virtual const char * caption() const
Human readable caption of the extension.
Definition: antares-study.cpp:374
virtual void userdataDestroy(void *userdata)
Destroy user data.
Definition: antares-study.cpp:400
Definition: fswalker.h:56