class: etk::Archive

Description:

Associated Namespace:

archive

class:

• Content

Constructor and Destructor:

+                                       Archive     (const std::string & _fileName);
+ virtual                               ~Archive    ();

Synopsis:

#         std::string                   m_fileName;
+         const std::string &           getFileName ();
#         std::map<std::string,Content> m_content;
+         int32_t                       size        () const;
+         const std::string &           getName     (size_t _id) const;
+         const Content &               getContent  (size_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     ();
# virtual void                          loadFile    (const std::map ,
                                                     Content>::iterator & it);
+         Archive*                      load        (const std::string & _fileName);

Object Hierarchy:

etk::Archive
  +--> etk::archive::Zip

Detail:

+  Archive (const std::string & _fileName);

+ virtual  ~Archive ();

# std::string m_fileName;

+ const std::string & getFileName ();

Return:

the requested file name.

# std::map<std::string,Content> m_content;

+ int32_t size () const;

+ const std::string & getName (size_t _id) const;

Parameter [input]:	_id	id of the element (must be < Size())
Return:		FileName of the requested id

+ const Content & getContent (size_t _id) const;

+ const Content & getContent (const std::string & _key) const;

Parameter [input]:	_key	name of the file
Return:		FileName of the requested id

+ bool exist (const std::string & _key) const;

Parameter [input]:	_key	Name of the file
Return:		true if the file is present

+ void open (const std::string & _key);

Parameter [input]:

_key

Name of the file

+ void close (const std::string & _key);

Parameter [input]:

_key

Name of the file

+ void display ();

# virtual void loadFile (const std::map ,
                         Content>::iterator & it);

+ Archive* load (const std::string & _fileName);

Parameter [input]:	_fileName	File name of the specific archive.
Return:		A pointer an the specified archive, the user might delete it.