Main Page | Namespace List | Class List | File List | Namespace Members | Class Members | Related Pages

ARC_File Class Reference

An ARC file. More...

#include <libarc.h>

List of all members.

Public Member Functions

void Destroy ()
 Destroy the current instance.

virtual off_t GetMemberCount (const char *media_type=0) const =0
 Return the number of members in the ARC with the given media type.

virtual Member_IteratorGetMemberIterator (const char *media_type=0) const =0
 Return an iterator for members of the given media type.

virtual Member_IteratorGetMemberIterator (const Media_Type &media_type) const =0
 Return an iterator for members of the given media type.


Static Public Member Functions

ARC_FileCreate (const char *arc_path)
 Create a concrete instance of an ARC file.


Detailed Description

An ARC file.


Member Function Documentation

ARC_File* Create const char *  arc_path  )  [static]
 

Create a concrete instance of an ARC file.

Parameters:
arc_path Pathname of the ARC file.
Returns:
Pointer to the ARC file instance.
Exceptions:
std::invalid_argument The pathname is 0 or empty.
Unsupported_ARC_Format_Exception The file is in an unknown format.

void Destroy  ) 
 

Destroy the current instance.

virtual off_t GetMemberCount const char *  media_type = 0  )  const [pure virtual]
 

Return the number of members in the ARC with the given media type.

Parameters:
media_type Optional media type to count.
Returns:
Number of elements with the specified media type.

virtual Member_Iterator* GetMemberIterator const Media_Type media_type  )  const [pure virtual]
 

Return an iterator for members of the given media type.

The returned iterator must be destroyed using libarc::ARC_Member::Destroy when you are done with it.

Parameters:
media_type Media type to limit the types of the members returned by the iterator.
Returns:
Iterator for the specified media types.

virtual Member_Iterator* GetMemberIterator const char *  media_type = 0  )  const [pure virtual]
 

Return an iterator for members of the given media type.

The returned iterator must be destroyed using libarc::ARC_Member::Destroy when you are done with it.

Parameters:
media_type Optional media type to limit the types of the members returned by the iterator.
Returns:
Iterator for the specified media types.


Generated on Tue Jun 8 21:30:14 2004 by doxygen SourceForge.net Logo