Alientech 0.01
An extendable game engine
alien::utils::ACHFile Class Reference

Describes a file in a CargoHold object. More...

#include <CACHFile.h>

List of all members.

Public Member Functions

 ACHFile (ACHDirectory *Parent, string Name, streampos Offset, unsigned Size)
 Constructor.
 ACHFile (ACHDirectory *Parent=NULL)
 Default constructor with option to include parent.
string getName ()
 Retrieves the name of the file.
streampos getOffset ()
 Retrieves the offset of the file within the CargoHold file.
unsigned getSize ()
 Retrieves the size of the file.
ACHDirectorygetParent ()
 Retrieves the parent directory of the file.
string getPath ()
 Retrieves the path of the file.
void setName (string NewName)
 Sets the name of the file.
void setOffset (streampos NewOffset)
 Sets the offset of the file within the CargoHold file.
void setParent (ACHDirectory *NewParent)
 Sets the parent directory of the file.
void setPath (string NewPath)
 Sets a new path for the file.

Detailed Description

Describes a file in a CargoHold object.

This class encapsulates the details of a file found in a CargoHold object. The end user/developer does not need to deal with it directly since it is just for internal use.

Definition at line 18 of file CACHFile.h.


Constructor & Destructor Documentation

ACHFile::ACHFile ( ACHDirectory Parent,
string  Name,
streampos  Offset,
unsigned  Size 
)

Constructor.

Parameters:
Parentthe directory to which this file belongs
Namename of the file
Offsetwhere in the CargoHold file it is located
Sizehow big the file is (in bytes)

Definition at line 4 of file CACHFile.cpp.

ACHFile::ACHFile ( ACHDirectory Parent = NULL)

Default constructor with option to include parent.

Parameters:
Parentthe directory to which this file belongs (NULL by default)

Definition at line 7 of file CACHFile.cpp.


Member Function Documentation

string ACHFile::getName ( )

Retrieves the name of the file.

Definition at line 10 of file CACHFile.cpp.

streampos ACHFile::getOffset ( )

Retrieves the offset of the file within the CargoHold file.

Definition at line 15 of file CACHFile.cpp.

ACHDirectory * ACHFile::getParent ( )

Retrieves the parent directory of the file.

Definition at line 25 of file CACHFile.cpp.

string ACHFile::getPath ( )

Retrieves the path of the file.

Definition at line 30 of file CACHFile.cpp.

unsigned ACHFile::getSize ( )

Retrieves the size of the file.

Definition at line 20 of file CACHFile.cpp.

void ACHFile::setName ( string  NewName)

Sets the name of the file.

Parameters:
NewNamethe new name of the file

Definition at line 35 of file CACHFile.cpp.

void ACHFile::setOffset ( streampos  NewOffset)

Sets the offset of the file within the CargoHold file.

Parameters:
NewOffsetthe new offset of the file

Definition at line 40 of file CACHFile.cpp.

void ACHFile::setParent ( ACHDirectory NewParent)

Sets the parent directory of the file.

Parameters:
NewParentthe new parent of the file

Definition at line 45 of file CACHFile.cpp.

void ACHFile::setPath ( string  NewPath)

Sets a new path for the file.

Parameters:
NewPaththe new path

Definition at line 50 of file CACHFile.cpp.


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