Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
MyStudyFinder Class Reference
Inheritance diagram for MyStudyFinder:
Antares::Data::StudyFinder Antares::Data::StudyFinder Antares::Data::StudyFinder

Public Member Functions

void onStudyFound (const String &folder, const Data::StudyVersion &version)
 
void onStudyFound (const String &folder, const Data::StudyVersion &version) override
 
- Public Member Functions inherited from Antares::Data::StudyFinder
 StudyFinder ()
 Default Constructor.
 
 StudyFinder (const StudyFinder &)
 Copy constructor.
 
virtual ~StudyFinder ()
 Destructor.
 
void lookup (const Yuni::String &folder)
 Start a new lookup from a single folder.
 
void lookup (const Yuni::String::Vector &folders)
 Start a new lookup from a list of folder.
 
void lookup (const Yuni::String::List &folders)
 Start a new lookup from a list of folder.
 
void stop (uint timeout=defaultTimeout)
 Stop a lookup currently in progress.
 
void wait ()
 Wait Indefinitely for the end of the lookup.
 
void wait (uint timeout)
 Wait for the end of the lookup (with timeout)
 
virtual void onStudyFound (const Yuni::String &folder, const StudyVersion &version)=0
 Event triggered when a lookup has been found.
 
virtual void onLookupFinished ()
 Event triggered when a lookup has finished gracefully.
 
virtual void onLookupAborted ()
 Event triggered when a lookup has been aborted.
 

Public Attributes

bool extra
 Print extra informations, such as the study version.
 
bool csv
 Print in CSV mode.
 
bool cleanup
 
bool listOnly
 
bool removeUselessTimeseries
 
bool forceReadonly
 

Additional Inherited Members

- Public Types inherited from Antares::Data::StudyFinder
enum  { defaultTimeout = 10000 }
 
using FolderVector = std::vector<Yuni::String::Ptr>
 List of folders.
 
- Protected Attributes inherited from Antares::Data::StudyFinder
std::mutex mutex
 

The documentation for this class was generated from the following files: