File Class Reference

The File class - Abstract class for FsFile, YaFile and AppFile. More...

#include <FileManager.hpp>

Inheritance diagram for File:

Collaboration diagram for File:

Public Types
enum class	Type { Directory = 0 , Track = 1 , Radio = 2 }

Public Member Functions
	File (Client &client, const std::string &name, fs::path path, const std::string &location_id, File::Type type, int playlistId=-1)
virtual void	NewFile (File_Ptr newFile)
	File::NewFile - substitute current file with a new file. Used to navigate between directories/folders. Will be processed by it's specific client.
virtual std::vector< File_Ptr >	GetDirFiles (bool noDirs=false, bool onlyMusicExtensions=false, bool recursively=false)
	File::GetDirFiles - get files in current directory/folder. Will be processed by it's specific client.
virtual std::pair< std::string, std::string >	GetSongData ()
virtual std::string	GetFromType () const

Public Attributes
Client &	client
std::string	name
fs::path	path
std::string	location_id
int	playlistId
File::Type	type

Detailed Description

The File class - Abstract class for FsFile, YaFile and AppFile.

Designed to work with it like it's simple file/folder

• Each File has Client, FsFile - FSClient; YaFile - YandexClient, etc.
• path - mostly for FsFile, but I update it for all
• location_id - for Yandex; yandex id or album id
• playlistId - for AppFile;

Member Function Documentation

GetDirFiles()

std::vector< File_Ptr > File::GetDirFiles ( bool noDirs = false, bool onlyMusicExtensions = false, bool recursively = false )

virtual

File::GetDirFiles - get files in current directory/folder.
Will be processed by it's specific client.

Parameters

noDirs	- exclude/include directories in return vector
onlyMusicExtensions	- files like .mp3 .wav etc
recursively	- search in each folder recursively

Returns

- files and possibly folders in current directory

---

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

• /home/archer/sweet_home/MyGithub/supported/YCLIMP/include/FileManager.hpp
• /home/archer/sweet_home/MyGithub/supported/YCLIMP/src/FileManager.cpp