Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Public Attributes | Friends | List of all members
vl::ZippedFileInfo Class Reference

Collects the information about a ZippedFile. More...

#include <ZippedFile.hpp>

+ Inheritance diagram for vl::ZippedFileInfo:

Public Member Functions

 ZippedFileInfo ()
 
unsigned short versionNeeded () const
 
unsigned short generalPurposeFlag () const
 
unsigned short compressionMethod () const
 
unsigned int crc32 () const
 
unsigned int compressedSize () const
 
unsigned int uncompressedSize () const
 
unsigned short fileNameLength () const
 
unsigned short extraFieldLength () const
 
int second () const
 
int minute () const
 
int hour () const
 
int day () const
 
int month () const
 
int year () const
 
const Stringpath () const
 
unsigned int zippedFileOffset () const
 
const VirtualFilesourceZipFile () const
 
VirtualFilesourceZipFile ()
 
void setSourceZipFile (VirtualFile *file)
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Public Attributes

unsigned short mVersionNeeded
 
unsigned short mGeneralPurposeFlag
 
unsigned short mCompressionMethod
 
unsigned int mCRC32
 
unsigned int mCompressedSize
 
unsigned int mUncompressedSize
 
unsigned short mFileNameLength
 
unsigned short mExtraFieldLength
 
int mSecond
 
int mMinute
 
int mHour
 
int mDay
 
int mMonth
 
int mYear
 
String mFileName
 
unsigned int mZippedFileOffset
 
ref< VirtualFilemSourceZipFile
 

Friends

class ZippedFile
 
class ZippedDirectory
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

Collects the information about a ZippedFile.

Definition at line 46 of file ZippedFile.hpp.

Constructor & Destructor Documentation

◆ ZippedFileInfo()

vl::ZippedFileInfo::ZippedFileInfo ( )
inline

Member Function Documentation

◆ compressedSize()

unsigned int vl::ZippedFileInfo::compressedSize ( ) const
inline

Definition at line 78 of file ZippedFile.hpp.

References mCompressedSize.

Referenced by vl::ZippedFile::fillUncompressedBuffer().

◆ compressionMethod()

unsigned short vl::ZippedFileInfo::compressionMethod ( ) const
inline

Definition at line 76 of file ZippedFile.hpp.

References mCompressionMethod.

◆ crc32()

unsigned int vl::ZippedFileInfo::crc32 ( ) const
inline

Definition at line 77 of file ZippedFile.hpp.

References mCRC32.

◆ day()

int vl::ZippedFileInfo::day ( ) const
inline

Definition at line 85 of file ZippedFile.hpp.

References mDay.

◆ extraFieldLength()

unsigned short vl::ZippedFileInfo::extraFieldLength ( ) const
inline

Definition at line 81 of file ZippedFile.hpp.

References mExtraFieldLength.

◆ fileNameLength()

unsigned short vl::ZippedFileInfo::fileNameLength ( ) const
inline

Definition at line 80 of file ZippedFile.hpp.

References mFileNameLength.

◆ generalPurposeFlag()

unsigned short vl::ZippedFileInfo::generalPurposeFlag ( ) const
inline

Definition at line 75 of file ZippedFile.hpp.

References mGeneralPurposeFlag.

Referenced by vl::ZippedFile::extract().

◆ hour()

int vl::ZippedFileInfo::hour ( ) const
inline

Definition at line 84 of file ZippedFile.hpp.

References mHour.

◆ minute()

int vl::ZippedFileInfo::minute ( ) const
inline

Definition at line 83 of file ZippedFile.hpp.

References mMinute.

◆ month()

int vl::ZippedFileInfo::month ( ) const
inline

Definition at line 86 of file ZippedFile.hpp.

References mMonth.

◆ path()

const String& vl::ZippedFileInfo::path ( ) const
inline

Definition at line 88 of file ZippedFile.hpp.

References mFileName.

◆ second()

int vl::ZippedFileInfo::second ( ) const
inline

Definition at line 82 of file ZippedFile.hpp.

References mSecond.

◆ setSourceZipFile()

void vl::ZippedFileInfo::setSourceZipFile ( VirtualFile file)
inline

Definition at line 94 of file ZippedFile.hpp.

References mSourceZipFile.

Referenced by vl::ZippedDirectory::init().

◆ sourceZipFile() [1/2]

const VirtualFile* vl::ZippedFileInfo::sourceZipFile ( ) const
inline

◆ sourceZipFile() [2/2]

VirtualFile* vl::ZippedFileInfo::sourceZipFile ( )
inline

Definition at line 93 of file ZippedFile.hpp.

References mSourceZipFile.

◆ uncompressedSize()

unsigned int vl::ZippedFileInfo::uncompressedSize ( ) const
inline

◆ versionNeeded()

unsigned short vl::ZippedFileInfo::versionNeeded ( ) const
inline

Definition at line 74 of file ZippedFile.hpp.

References mVersionNeeded.

Referenced by vl::ZippedFile::extract().

◆ year()

int vl::ZippedFileInfo::year ( ) const
inline

Definition at line 87 of file ZippedFile.hpp.

References mYear.

◆ zippedFileOffset()

unsigned int vl::ZippedFileInfo::zippedFileOffset ( ) const
inline

Friends And Related Function Documentation

◆ ZippedDirectory

friend class ZippedDirectory
friend

Definition at line 49 of file ZippedFile.hpp.

◆ ZippedFile

friend class ZippedFile
friend

Definition at line 48 of file ZippedFile.hpp.

Member Data Documentation

◆ mCompressedSize

unsigned int vl::ZippedFileInfo::mCompressedSize

◆ mCompressionMethod

unsigned short vl::ZippedFileInfo::mCompressionMethod

◆ mCRC32

unsigned int vl::ZippedFileInfo::mCRC32

◆ mDay

int vl::ZippedFileInfo::mDay

Definition at line 108 of file ZippedFile.hpp.

Referenced by day(), vl::ZippedDirectory::init(), and ZippedFileInfo().

◆ mExtraFieldLength

unsigned short vl::ZippedFileInfo::mExtraFieldLength

Definition at line 104 of file ZippedFile.hpp.

Referenced by extraFieldLength(), vl::ZippedDirectory::init(), and ZippedFileInfo().

◆ mFileName

String vl::ZippedFileInfo::mFileName

Definition at line 111 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), and path().

◆ mFileNameLength

unsigned short vl::ZippedFileInfo::mFileNameLength

Definition at line 103 of file ZippedFile.hpp.

Referenced by fileNameLength(), vl::ZippedDirectory::init(), and ZippedFileInfo().

◆ mGeneralPurposeFlag

unsigned short vl::ZippedFileInfo::mGeneralPurposeFlag

Definition at line 98 of file ZippedFile.hpp.

Referenced by generalPurposeFlag(), vl::ZippedDirectory::init(), and ZippedFileInfo().

◆ mHour

int vl::ZippedFileInfo::mHour

Definition at line 107 of file ZippedFile.hpp.

Referenced by hour(), vl::ZippedDirectory::init(), and ZippedFileInfo().

◆ mMinute

int vl::ZippedFileInfo::mMinute

Definition at line 106 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), minute(), and ZippedFileInfo().

◆ mMonth

int vl::ZippedFileInfo::mMonth

Definition at line 109 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), month(), and ZippedFileInfo().

◆ mSecond

int vl::ZippedFileInfo::mSecond

Definition at line 105 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), second(), and ZippedFileInfo().

◆ mSourceZipFile

ref<VirtualFile> vl::ZippedFileInfo::mSourceZipFile

Definition at line 115 of file ZippedFile.hpp.

Referenced by setSourceZipFile(), and sourceZipFile().

◆ mUncompressedSize

unsigned int vl::ZippedFileInfo::mUncompressedSize

◆ mVersionNeeded

unsigned short vl::ZippedFileInfo::mVersionNeeded

Definition at line 97 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), versionNeeded(), and ZippedFileInfo().

◆ mYear

int vl::ZippedFileInfo::mYear

Definition at line 110 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), year(), and ZippedFileInfo().

◆ mZippedFileOffset

unsigned int vl::ZippedFileInfo::mZippedFileOffset

Definition at line 113 of file ZippedFile.hpp.

Referenced by vl::ZippedDirectory::init(), ZippedFileInfo(), and zippedFileOffset().


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