class: etk::Archive
Description:
Associated Namespace:
class:
Constructor and Destructor:
+ Archive (const std::string & _fileName);
+ virtual ~Archive (void );
Synopsis:
# std::string m_fileName;
+ const std::string & getFileName (void );
# etk::Hash<Content> m_content;
+ int32_t size (void ) const;
+ const std::string & getName (int32_t _id) const;
+ const Content & getContent (int32_t _id) const;
+ const Content & getContent (const std::string & _key) const;
+ bool exist (const std::string & _key) const;
+ void open (const std::string & _key);
+ void close (const std::string & _key);
+ void display (void );
# virtual void loadFile (int32_t _id);
+ Archive* load (const std::string & _fileName);
Object Hierarchy:
etk::Archive
+--> etk::archive::Zip
Detail:
Archive
+ Archive (const std::string & _fileName);
~Archive
+ virtual ~Archive (void );
m_fileName
# std::string m_fileName;
File name when it came from an file
getFileName
+ const std::string & getFileName (void );
Get the current file name.
Return: the requested file name.
m_content
# etk::Hash<Content> m_content;
size
+ int32_t size (void ) const;
Get the number of elements
Return: nb files in the archive
getName
+ const std::string & getName (int32_t _id) const;
Get the File name of the ID
Parameter [input]: _id id of the element (must be < Size())
Return: FileName of the requested id
getContent
+ const Content & getContent (int32_t _id) const;
Get the File name of the ID
Parameter [input]: _id id of the element (must be < Size())
Return: the archive content
getContent
+ const Content & getContent (const std::string & _key) const;
Get the File name of the ID
Parameter [input]: _key name of the file
Return: FileName of the requested id
exist
+ bool exist (const std::string & _key) const;
Check if a file exist
Parameter [input]: _key Name of the file
Return: true if the file is present
open
+ void open (const std::string & _key);
Load the specific file in the memory
Parameter [input]: _key Name of the file
close
+ void close (const std::string & _key);
Un-Load the specific file from the memory
Parameter [input]: _key Name of the file
display
+ void display (void );
Display all Element in the archive
loadFile
# virtual void loadFile (int32_t _id);
Request the load in memory of the concerned file.
Parameter [input]: _id Id of the file to load.
load
+ Archive* load (const std::string & _fileName);
Load an Achive with a specific name.
Parameter [input]: _fileName File name of the specific archive.
Return: A pointer an the specified archive, the user might delete it.
etk::Archive
+--> etk::archive::Zip
Detail:
Archive
+ Archive (const std::string & _fileName);
~Archive
+ virtual ~Archive (void );
m_fileName
# std::string m_fileName;File name when it came from an file
getFileName
+ const std::string & getFileName (void );Get the current file name.
| Return: | the requested file name. |
m_content
# etk::Hash<Content> m_content;
size
+ int32_t size (void ) const;Get the number of elements
| Return: | nb files in the archive |
getName
+ const std::string & getName (int32_t _id) const;Get the File name of the ID
| Parameter [input]: | _id | id of the element (must be < Size()) |
| Return: | FileName of the requested id |
getContent
+ const Content & getContent (int32_t _id) const;Get the File name of the ID
| Parameter [input]: | _id | id of the element (must be < Size()) |
| Return: | the archive content |
getContent
+ const Content & getContent (const std::string & _key) const;Get the File name of the ID
| Parameter [input]: | _key | name of the file |
| Return: | FileName of the requested id |
exist
+ bool exist (const std::string & _key) const;Check if a file exist
| Parameter [input]: | _key | Name of the file |
| Return: | true if the file is present |
open
+ void open (const std::string & _key);Load the specific file in the memory
| Parameter [input]: | _key | Name of the file |
close
+ void close (const std::string & _key);Un-Load the specific file from the memory
| Parameter [input]: | _key | Name of the file |
display
+ void display (void );Display all Element in the archive
loadFile
# virtual void loadFile (int32_t _id);Request the load in memory of the concerned file.
| Parameter [input]: | _id | Id of the file to load. |
load
+ Archive* load (const std::string & _fileName);Load an Achive with a specific name.
| Parameter [input]: | _fileName | File name of the specific archive. |
| Return: | A pointer an the specified archive, the user might delete it. |