zipios::ZipCDirEntry Class Reference

Specialization of ZipLocalEntry, that add fields for storing the extra information, that is only present in the entries in the zip central directory and not in the local entry headers. More...

#include <ziphead.h>

Public Member Functions

virtual FileEntryclone () const
 Create a heap allocated clone of the object this method is called for. More...
 
int getCDirHeaderSize () const
 
virtual string getComment () const
 Returns the comment of the entry, if it has one. More...
 
virtual uint32 getLocalHeaderOffset () const
 
virtual void setComment (const string &comment)
 Sets the comment field for the FileEntry. More...
 
void setDefaultWriter ()
 
virtual void setLocalHeaderOffset (uint32 offset)
 
virtual string toString () const
 Returns a human-readable string representation of the entry. More...
 
 ZipCDirEntry (const string &_filename="", const string &_file_comment="", const vector< unsigned char > &_extra_field=vector< unsigned char >())
 
virtual ~ZipCDirEntry ()
 
- Public Member Functions inherited from zipios::ZipLocalEntry
virtual FileEntryclone () const
 Create a heap allocated clone of the object this method is called for. More...
 
virtual string getComment () const
 Returns the comment of the entry, if it has one. More...
 
virtual uint32 getCompressedSize () const
 Returns the compressed size of the entry. More...
 
virtual uint32 getCrc () const
 Returns the Crc for the entry, if it has one. More...
 
virtual vector< unsigned char > getExtra () const
 Returns a vector of bytes of extra data that may be stored with the entry. More...
 
virtual string getFileName () const
 Returns the filename of the entry. More...
 
int getLocalHeaderSize () const
 
virtual StorageMethod getMethod () const
 Returns the method used to store the entry in the FileCollection. More...
 
virtual string getName () const
 Returns the full filename of the entry, including a path if the entry is stored in a subfolder. More...
 
virtual uint32 getSize () const
 Returns the (uncompressed) size of the entry data. More...
 
virtual int getTime () const
 Returns the date and time of FIXME: what?
More...
 
virtual bool isDirectory () const
 Returns true if the entry is a directory. More...
 
virtual bool isValid () const
 Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not. More...
 
virtual void setComment (const string &comment)
 Sets the comment field for the FileEntry. More...
 
virtual void setCompressedSize (uint32 size)
 Set the compressed size field of the entry. More...
 
virtual void setCrc (uint32 crc)
 Sets the crc field. More...
 
void setDefaultExtract ()
 
virtual void setExtra (const vector< unsigned char > &extra)
 Sets the extra field. More...
 
virtual void setMethod (StorageMethod method)
 Sets the storage method field for the entry. More...
 
virtual void setName (const string &name)
 Sets the name field for the entry. More...
 
virtual void setSize (uint32 size)
 Sets the size field for the entry. More...
 
virtual void setTime (int time)
 Sets the time field for the entry. More...
 
virtual string toString () const
 Returns a human-readable string representation of the entry. More...
 
bool trailingDataDescriptor () const
 
 ZipLocalEntry (const string &_filename="", const vector< unsigned char > &_extra_field=vector< unsigned char >())
 
virtual ~ZipLocalEntry ()
 
- Public Member Functions inherited from zipios::FileEntry
virtual FileEntryclone () const =0
 Create a heap allocated clone of the object this method is called for. More...
 
virtual string getComment () const =0
 Returns the comment of the entry, if it has one. More...
 
virtual uint32 getCompressedSize () const =0
 Returns the compressed size of the entry. More...
 
virtual uint32 getCrc () const =0
 Returns the Crc for the entry, if it has one. More...
 
virtual vector< unsigned char > getExtra () const =0
 Returns a vector of bytes of extra data that may be stored with the entry. More...
 
virtual string getFileName () const =0
 Returns the filename of the entry. More...
 
virtual StorageMethod getMethod () const =0
 Returns the method used to store the entry in the FileCollection. More...
 
virtual string getName () const =0
 Returns the full filename of the entry, including a path if the entry is stored in a subfolder. More...
 
virtual uint32 getSize () const =0
 Returns the (uncompressed) size of the entry data. More...
 
virtual int getTime () const =0
 Returns the date and time of FIXME: what?
More...
 
virtual bool isDirectory () const =0
 Returns true if the entry is a directory. More...
 
virtual bool isValid () const =0
 Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not. More...
 
virtual void setComment (const string &comment)=0
 Sets the comment field for the FileEntry. More...
 
virtual void setCompressedSize (uint32 size)=0
 Set the compressed size field of the entry. More...
 
virtual void setCrc (uint32 crc)=0
 Sets the crc field. More...
 
virtual void setExtra (const vector< unsigned char > &extra)=0
 Sets the extra field. More...
 
virtual void setMethod (StorageMethod method)=0
 Sets the storage method field for the entry. More...
 
virtual void setName (const string &name)=0
 Sets the name field for the entry. More...
 
virtual void setSize (uint32 size)=0
 Sets the size field for the entry. More...
 
virtual void setTime (int time)=0
 Sets the time field for the entry. More...
 
virtual string toString () const =0
 Returns a human-readable string representation of the entry. More...
 
virtual ~FileEntry ()
 FileEntry destructor. More...
 

Friends

ostream & operator<< (ostream &os, const ZipCDirEntry &zcdh)
 
bool operator== (const ZipLocalEntry &zlh, const ZipCDirEntry &ze)
 
istream & operator>> (istream &is, ZipCDirEntry &zcdh)
 

Additional Inherited Members

- Protected Member Functions inherited from zipios::FileEntry
void ref () const
 
unsigned int unref () const
 
- Protected Attributes inherited from zipios::ZipLocalEntry
uint16 compress_method
 
uint32 compress_size
 
uint32 crc_32
 
vector< unsigned char > extra_field
 
uint16 extra_field_len
 
uint16 extract_version
 
string filename
 
uint16 filename_len
 
uint16 gp_bitfield
 
uint16 last_mod_fdate
 
uint16 last_mod_ftime
 
uint32 uncompress_size
 
- Static Protected Attributes inherited from zipios::ZipLocalEntry
static const uint32 signature = 0x04034b50
 

Detailed Description

Specialization of ZipLocalEntry, that add fields for storing the extra information, that is only present in the entries in the zip central directory and not in the local entry headers.

Constructor & Destructor Documentation

◆ ZipCDirEntry()

zipios::ZipCDirEntry::ZipCDirEntry ( const string &  _filename = "",
const string &  _file_comment = "",
const vector< unsigned char > &  _extra_field = vector< unsigned char >() 
)

Referenced by clone().

◆ ~ZipCDirEntry()

virtual zipios::ZipCDirEntry::~ZipCDirEntry ( )
virtual

Member Function Documentation

◆ clone()

FileEntry * zipios::ZipCDirEntry::clone ( ) const
virtual

Create a heap allocated clone of the object this method is called for.

The caller is responsible for deallocating the clone when he is done with it.

Returns
A heap allocated copy of the object this method is called for.

Reimplemented from zipios::ZipLocalEntry.

References ZipCDirEntry().

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), ArchComponent.Component::execute(), ArchCurtainWall.CurtainWall::execute(), ArchTruss.Truss::execute(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::integrated(), and PathTests.TestPathHelix.TestPathHelix::test04().

◆ getCDirHeaderSize()

int zipios::ZipCDirEntry::getCDirHeaderSize ( ) const

◆ getComment()

string zipios::ZipCDirEntry::getComment ( ) const
virtual

Returns the comment of the entry, if it has one.

Otherwise it returns an empty string.

Returns
the comment associated with the entry, if there is one.

Reimplemented from zipios::ZipLocalEntry.

◆ getLocalHeaderOffset()

uint32 zipios::ZipCDirEntry::getLocalHeaderOffset ( ) const
virtual

◆ setComment()

void zipios::ZipCDirEntry::setComment ( const string &  comment)
virtual

Sets the comment field for the FileEntry.

Parameters
commentstring with the new comment.

Reimplemented from zipios::ZipLocalEntry.

◆ setDefaultWriter()

void zipios::ZipCDirEntry::setDefaultWriter ( )

◆ setLocalHeaderOffset()

void zipios::ZipCDirEntry::setLocalHeaderOffset ( uint32  offset)
virtual

◆ toString()

string zipios::ZipCDirEntry::toString ( ) const
virtual

Returns a human-readable string representation of the entry.

Returns
a human-readable string representation of the entry.

Reimplemented from zipios::ZipLocalEntry.

References zipios::ZipLocalEntry::compress_size, zipios::ZipLocalEntry::filename, zipios::OutputStringStream::str(), and zipios::ZipLocalEntry::uncompress_size.

Friends And Related Function Documentation

◆ operator<<

ostream & operator<< ( ostream &  os,
const ZipCDirEntry zcdh 
)
friend

◆ operator==

bool operator== ( const ZipLocalEntry zlh,
const ZipCDirEntry ze 
)
friend

◆ operator>>

istream & operator>> ( istream &  is,
ZipCDirEntry zcdh 
)
friend

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