Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Data::StudyCleaningInfos Class Referencefinal

Constructor & Destructor

Yuni::String folder
 
StudyVersion version
 
::PathList intruders
 
::PathList exclude
 
Yuni::String customExclude
 
::PathList postExclude
 
std::function< bool(uint)> onProgress
 Event triggered when entering into a new folder.
 
 StudyCleaningInfos ()
 Default Constructor.
 
 StudyCleaningInfos (const AnyString &path)
 Constructor with a given path.
 
 ~StudyCleaningInfos ()
 Destructor.
 
bool analyze ()
 Determine the complete list of all files/folder considered as intruders.
 
void performCleanup ()
 Perform a complete cleanup.
 
uint64_t totalSize () const
 Get the total size occupied by the intruders.
 
void setCustomExcludeList (const Yuni::String &c)
 Set an additional list of excluded files or directories.
 

Member Data Documentation

◆ customExclude

Yuni::String Antares::Data::StudyCleaningInfos::customExclude

Colon-separated list of all files/folders to prevent from the destruction

◆ exclude

::PathList Antares::Data::StudyCleaningInfos::exclude

List of all files/folders to prevent from the destruction

◆ folder

Yuni::String Antares::Data::StudyCleaningInfos::folder

A study folder

◆ intruders

::PathList Antares::Data::StudyCleaningInfos::intruders

List of all intruders

◆ onProgress

std::function<bool(uint)> Antares::Data::StudyCleaningInfos::onProgress

Event triggered when entering into a new folder.

Return false to stop the process

◆ postExclude

::PathList Antares::Data::StudyCleaningInfos::postExclude

List of all files/folders to exclude after analyzing the content of the folder

◆ version

StudyVersion Antares::Data::StudyCleaningInfos::version

Version of the study


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