ALFileManager manages the user files stored in a shared folder.
Note that FileManager starts to look in the shared folder, and if it does not find anything,
then it looks in the data folder.
Shared folder can be changed on the fly, and module will then be able to say which
files are available in this folder, as well as return their complete path.
void setUserSharedFolderPath (const string& fileName)
Set a new value of the user shared folder path.
Name of the module associate to the preference.
string getUserSharedFolderPath ()
Get the current user shared folder path.
User shared folder path string.
string getSystemSharedFolderPath ()
Get the current system shared folder path.
System shared folder path string.
bool fileExists (const string& fileName)
Try to find if this file does exist on robot or not.
Name of the module associate to the preference.
True upon success
bool dataFileExists (const string& fileName)
Try to find if this file does exist on robot or not.
Name of the module associate to the preference.
True upon success
string getFileCompletePath (const string& prefs)
Returns the complete path of the file if it does exist. Starts by looking in user's shared folder, then in system folder.
array reprenting the whole file.
True upon success
AL::ALValue getFileContents (const string& prefs)
Returns the complete path of the file if it does exist. Starts by looking in user's shared folder, then in system folder.
array reprenting the whole file.
True upon success
string version ()
Returns the version of the module.
A string containing the version of the module.
AL::ALValue getMethodHelp (const string& methodName)
Retrieves a method's description.
The name of the method.
A structure containing the method's description.
AL::ALValue getModuleHelp ()
Retrieves the module's description.
A structure describing the module.
string getUsage (const string& name)
Gets the method usage string. This summarise how to use the method.
The name of the method.
A string that summarises the usage of the method.