Alientech 0.01
An extendable game engine
utils::AlienCargoHold Class Reference

Main class containing everything needed to load and read from a Cargo Hold Packed file. More...

#include <CAlienCargoHold.h>

List of all members.

Public Member Functions

 AlienCargoHold (string filename)
 Constructor.
bool isOpen ()
 Checks if the CargoHold file is open. This function can be used for error checking. If it returns false then the file could not be open.
ACHDirectorygetRoot ()
 Retrieves a pointer to the root directory. Do not use this function to modify the file/directory structure.
 ~AlienCargoHold ()
 Destructor.

Detailed Description

Main class containing everything needed to load and read from a Cargo Hold Packed file.

This class will handle opening, parsing and closing the CargoHold file. It provides a pointer to the root directory only for printing and debugging purposes and it should not be used for manual manipulation of the file structure.

Note: Libraries that wish to use files from this object need to support all of their file handling operations assuming that all they have is a pointer to the file object that has already been setup for reading from the specified file

Definition at line 23 of file CAlienCargoHold.h.


Constructor & Destructor Documentation

utils::AlienCargoHold::AlienCargoHold ( string  filename)

Constructor.

Parameters:
filenamethe name/location of the CargoHold file
utils::AlienCargoHold::~AlienCargoHold ( )

Destructor.


Member Function Documentation

ACHDirectory* utils::AlienCargoHold::getRoot ( )

Retrieves a pointer to the root directory. Do not use this function to modify the file/directory structure.

Returns:
pointer to the root directory
bool utils::AlienCargoHold::isOpen ( )

Checks if the CargoHold file is open. This function can be used for error checking. If it returns false then the file could not be open.

Returns:
true if file open, false otherwise

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